jsdoc / jsdoc.github.io

JSDoc website
https://jsdoc.app/
Other
203 stars 104 forks source link

Explain doclets better #68

Open hegemonic opened 9 years ago

hegemonic commented 9 years ago

JSDoc uses the term "doclet" to refer to an object that represents the documentation for a JS symbol. It's important to know something about doclets if you're doing any of the following:

We need a page that does all of the following:

hegemonic commented 9 years ago

Folding #58 into this issue:

Starting with jsdoc3/jsdoc@1171593, doclets can contain a parsedType property that contains the parsed type from Catharsis. The contents of this property are subject to change.

The property is non-enumerable unless the --debug flag is enabled.