Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support @author tag #2603

Closed
regseb opened this issue Jun 22, 2024 · 1 comment
Closed

Support @author tag #2603

regseb opened this issue Jun 22, 2024 · 1 comment
Labels
bug Functionality does not match expectation
Milestone

Comments

@regseb
Copy link

regseb commented Jun 22, 2024

Search terms

@author

Expected Behavior

TypeDoc supports @author tag.

Actual Behavior

TypeDoc repport: Encountered an unknown block tag @author

Steps to reproduce the bug

package.json

{
  "name": "testcase",
  "version": "1.0.0",
  "dependencies": {
    "typedoc": "0.26.0",
    "typescript": "5.5.2"
  }
}

tsconfig.json

{
  "typedocOptions": {
    "entryPoints": ["index.ts"]
  }
}

index.ts

/**
 * @author Ian Awesome
 */

Steps

  1. npm install

  2. npx typedoc

    ./index.ts:2:3 - [warning] Encountered an unknown block tag @author
    
    2     * @author Ian Awesome
    
    [info] Documentation generated at ./docs
    [warning] Found 0 errors and 1 warnings
    

Environment

  • Typedoc version: 0.26.0
  • TypeScript version: 5.5.2
  • Node.js version: 20.14.0
  • OS: Ubuntu 22.04.4 LTS
@regseb regseb added the bug Functionality does not match expectation label Jun 22, 2024
@Gerrit0 Gerrit0 added this to the v0.26.1 milestone Jun 22, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 25, 2024

Since I suspect more people will run into similar issues, linking #2614 (comment) here as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants