it looks like the libraries do not generate properties - Githubissues

xperiments / TSDoc

A JSDoc3 base themed generator generator for use with Typescript Projects, uses a highly modified version Docstrap JsDoc3 Template.

MIT License

48 stars 12 forks source link

it looks like the libraries do not generate properties #14

Closed DonatoTotalSim closed 7 years ago

DonatoTotalSim commented 7 years ago

Thank you for sharing this fantastic library.

I am experiencing a problem. The following comments generate the right documentation:

/**

Angular2 implementation of the THREE.js library aaa
@class ThreedViewerComponent
@classdesc Angular2 implementation of the THREE.js library
@param {void}
@param {someData} data Param Description */ ... some code here

/**

The ngOnInit() is a angular lifecycle hook used to initialize the ThreedViewerComponent after angular data bound initialisation
@event ThreedViewerComponent.events:ngOnInit */ ... some code here

but the following code does not display the property of the ThreedViewerComponent: /**

sceneHeight description
@access private
@member {number} ThreedViewerComponent.sceneHeight */ sceneHeight: number;

Am I doing something wrong? Is it a bug?

Thank you.

Donato

DonatoTotalSim commented 7 years ago

OK, it was me being stupid. In order to generate private methods the user needs to add the option:

"private" :"true"

into the options section of the tsdoc.json file e.g.

"opts":
    {
        ...
        "recurse"   :"true",
                "private" :"true"
    },

I will not delete the issue in case someone incurs in the same blunder...