Typedoc: @category not rendered properly

Created on 21 Mar 2019  路  4Comments  路  Source: TypeStrong/typedoc

Just tried the latest category tag, and the interfaces/functions/methods can be grouped on the index, but the @category tags and the category names still appear in the descriptions of each interface/function/method.

image

Steps to reproduce the bug

The ts code

    /**
     * The Client object returned by the {@link createClient} method provides access to much of the core AgoraRTC functionality.
     * @category Core
     */
    interface Client

Typedoc config

"typedocOptions": { "mode": "file", "hideGenerator": true, "defaultCategory": "Miscellaneous", "categorizeByGroup": true, "includes": "types", "excludeExternals": true, "includeDeclarations": true, "target": "ES6", }

Environment

  • Typedoc version: 0.14.2
  • Node.js version: 11.12.0
  • OS: macOS Mojave
bug

Most helpful comment

Included a fix for this in https://github.com/TypeStrong/typedoc/pull/1008. It will remove the comment tag when the category is resolved.

All 4 comments

Typedoc version: 0.14.2

The category changes merged to master 2 days ago have not yet been released. Are you running on master or from npm?

Typedoc version: 0.14.2

The category changes merged to master 2 days ago have not yet been released. Are you running on master or from npm?

Running on master. I can get the index in the categories I set.

Oh, gotcha, I misread the initial report. Yea, this is a bug. It should be a fairly simple fix, we just have to add category to the list of tags that won't be rendered.

Included a fix for this in https://github.com/TypeStrong/typedoc/pull/1008. It will remove the comment tag when the category is resolved.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ShadowManu picture ShadowManu  路  4Comments

lsagetlethias picture lsagetlethias  路  3Comments

Bibliofile picture Bibliofile  路  3Comments

rbuckton picture rbuckton  路  3Comments

topherfangio picture topherfangio  路  3Comments