@category not working for functions within modules

[geethika18]

Requirement
Within a module, there should be a way to classify/categorize the functions - ex: content creation functions, content editing functions etc.

Tried out something similar to what was mentioned in #566

But @category tag was taking effect only on classes.

[aciccarello]

Am I correct to assume by module you are referring to a file defined similar to the below?

/**
 * @category SomeCategory
 **/
function myFunction() {
}

Related to #866

[geethika18]

Hi @aciccarello,

I have a ts file defined as below

namespace ABC{

/**

• @category abc.1
  */
  export function1() {
  }

/**

• @category abc.2
  */
  export function2() {
  }
  ...
  }

My requirement is to have these categories produce different pages or even different sections within the same page. Please help me out with the same.

[geethika18]

Can I get some help here?

[Gerrit0]

I don't believe this is supported with the default theme yet, #866 might resolve this.

[jonchardy]

Yes, see #866. I'm willing to help make some changes here, but need some input on desired behavior.

[geethika18]

Hi @jonchardy,

Thanks for volunteering. So here's my use case

test.txt

When typedoc is run the output should have 2 sections - category 1 and category 2 - all the methods should be grouped together based on category.

Thank you!

[geethika18]

Hi @jonchardy ,

Any luck with this? Please let me know. Thanks.

[geethika18]

Hi,

Could someone please help me out with this issue?

[geethika18]

Output generated

Expected output

The theme used is same, but in 2nd case I had to duplicate my input file which is basically a weird work-around. Please suggest me the right approach.

[jonchardy]

See #938

[geethika18]

Hi @jonchardy ,

Could you kindly share the ETA for releasing this change?

[jonchardy]

I don't know, I'm just a contributor. @aciccarello

[aciccarello]

Sorry, there is no ETA at the moment. The PR will need to be reviewed. Additionally there are some issues with releasing themes at the moment.

[geethika18]

Hi @aciccarello ,

Could you please share the ETA for releasing this change? I see that the change is merged. Thank you.