better-docs
better-docs copied to clipboard
@subcategory tag does not work
Hello,
I am using the latest version of better-docs with the @category tag. I am also trying to apply the @subcategory tag but I have not had any success getting the subcategory to show up. Instead, I am simply seeing "GLOBAL" under the category. Below is the configuration I am using based on the docs.
`/**
- Service to authenticate something
- @category Services
- @subcategory Authentication
- @param {!Object} - object containing username and password
- @return {Promise} - Promise */`
{ "tags": { "allowUnknownTags": true }, "source": { "include": ["./src"], "includePattern": ".js$", "excludePattern": "(node_modules/|docs)" }, "plugins": [ "plugins/markdown", "jsdoc-mermaid", "node_modules/better-docs/category" ], "opts": { "encoding": "utf8", "destination": "docs/", "readme": "readme.md", "recurse": true, "verbose": true, "template": "node_modules/better-docs" }, "templates": { "cleverLinks": false, "monospaceLinks": false, "search": true, "better-docs": { "name": "Code Documentation", "title": "", "css": "style.css", "trackingCode": "tracking-code-which-will-go-to-the-HEAD", "hideGenerator": false } } }
I also encountered the same problem, Did you solve it?
I also encountered the same problem, How to solve?
I am afraid @subcategory won't work with global objects. It was designed to be subcategory for classes, interfaces etc.
To fix that you can add @module or @class tag to specify the type of the doclet
Well, we can use the@module tag but it outputs the full relative path of the module instead of the filename. Any fix would be helpful.