jsdoc-to-markdown icon indicating copy to clipboard operation
jsdoc-to-markdown copied to clipboard

@category grouping should also apply in the global index

Open captncraig opened this issue 9 years ago • 1 comments

I have the following js (simple.js):

/**
 * foo!
 * @category A
 */
function foo(){}

/**
 * bar!
 * @category A
 */
function bar(){}

/**
 * baz!
 * @category B
 */
function baz(){}

/**
 * foobar!
 * @category B
 */
function foobar(){}

Running through jsdoc2md -g grouped simple.js gives me a global index in this format:

## Functions

* [foo()](#foo)
* [bar()](#bar)
* [baz()](#baz)
* [foobar()](#foobar)

I really really want those globals grouped by categories. --group-by didn't seem to have any effect. Is this not a supported feature, or am I using it wrong?

captncraig avatar Aug 09 '16 07:08 captncraig

Hi! Yes, those globals should be grouped too. I will look into this soon, thanks.


Try the jsdoc2md v2 pre-release

75lb avatar Aug 09 '16 22:08 75lb