Tags '@return' and '@param' not recognized

[rishab0409]

Hi

I have a project where the functions are defined as below.

import {utilities} from '../../sandbox'
export const action = {
    /**
     * Function to perform action 1
     * @param param1 Parameter 1 for the action 1
     * @param param2 Parameter 2 for the action 1
     * @returns action status 
     */

    action1: (param1: number, param2: string) => {
        return true;
    },    
    /**
    * Function to perform action 1
    * @param param1 Parameter 1 for the action 2
    * @param param2 Parameter 2 for the action 2
    * @returns action status 
    */

   action2: (param1: number, param2: string) => {
       return true;
   }
}

When I use typedoc to generate the documentation, '@return' and '@param' tags are getting recognized(as shown below)

But when I use the plugin to generate markdowns, '@param' and '@return' tags are getting skipped (as shown below)

[tgreyuk]

this is fixed in typedoc-plugin-markdown@next. I'll have a look at fixing in main release too.

[rishab0409]

@tgreyuk thanks for the response, I have verified that "@param" and "@return" parameters are getting recognized in typedoc-plugin-markdown@next. But this version is creating a new issue. The inPageTOC is not generated (as show below)

Previously when I used --objectLiteralTypeDeclarationStyle list it created a "type declaration" table as well as "type declaration" list(image below). Also ref

[tgreyuk]

Hi @rishab0409 . Do you think a table is also required with a list format? It creates a lot of repetition, especially if there are lots of members.

I suppose we could have more of a traditional TOC for the members like this?

[tgreyuk]

Closing as the desired result is to have a list style OR table (not both).