toast-ui.doc icon indicating copy to clipboard operation
toast-ui.doc copied to clipboard

Categories or Subcategories?

Open st-schneider opened this issue 4 years ago • 2 comments

Is it possible to add @category or something to manually group files or functions?

st-schneider avatar Mar 29 '20 14:03 st-schneider

@bm-stschneider First, @category is not defined in the tags specified in JSDoc. @toast-ui/doc parses and shows some of the tags specified in JSDoc. Could you explain in detail what a feature you want?

seonim-ryu avatar Apr 14 '20 08:04 seonim-ryu

https://jsdoc.app/about-configuring-jsdoc.html#default-configuration-options it is also possible to use tags jsdoc does not know by itself. The question was if it would be able to manually group stuff via a @category tag so that they appear as a group in the resulting doc. For example, if you have a bunch of grunt/gulp tasks and some utility files for them you could group them in @category grunt for example. They are not modules and also don't share a namespace so they would otherwise end up in the global namespace. and if they have no named export they will be hard to find.

st-schneider avatar Apr 14 '20 09:04 st-schneider