jdalton / docdown

A simple JSDoc to Markdown generator.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

New tag to categorize the methods in TOC

abozhilov opened this issue · comments

Most of the JavaScript libraries use single namespace where put all of the utility methods. Lodash is an example for that, Underscore etc.
For documentation would be great if there is an easy way to categorize the methods. For example if there is a JSDoc tag for that:

 @category Array
_.map = function (){};

 @category Function 
_.bind = function (){}; 

Yap, I really like the format of documentation of Lodash.
Did you push it the things about @category, because even with @category I don't get categorized output.
Thanks!

Got it.
Should pass 'toc' => 'categories'.
Would be good if you have some time to add it to the documentation of the docdown.

Would be good if you have some time to add it to the documentation of the docdown.

Ah yap, will do.