Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@category grouping should also apply in the global index #97

Open
captncraig opened this issue Aug 9, 2016 · 1 comment
Open

@category grouping should also apply in the global index #97

captncraig opened this issue Aug 9, 2016 · 1 comment

Comments

@captncraig
Copy link

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?

@75lb
Copy link
Member

75lb commented Aug 9, 2016

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


Try the jsdoc2md v2 pre-release

@75lb 75lb changed the title Grouping Global functions not working? @category grouping should also apply in the global index Sep 5, 2016
@75lb 75lb transferred this issue from jsdoc2md/jsdoc-to-markdown Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants