search

SalesforceFoundation / ApexDoc

The latest java source for ApexDoc, a tool to document your Salesforce Apex classes.
BSD 3-Clause "New" or "Revised" License
229 stars 128 forks source link

Provide option to not document classes, methods, and properties that do not have a comment block. #4

Open davidhabib opened 9 years ago

davidhabib commented 9 years ago

Currently, ApexDoc will include in the documentation set all classes, methods, and properties that are of the specified scope(s).

Some users may prefer to only have it generate documentation for classes, methods, and properties that have a comment block.

It would be nice to provide an option (command line flag, and PlugIn checkbox) to control this behavior.

Feb 6, 2013 Delete comment #1 thusted@nimbleuser.com The skip-undocumented option is useful when documenting the global classes in a managed package, and there are some utility classes that are not included in the package.

jlantz commented 9 years ago

It would be nice to be able to generate a report from this functionality of all the places that were skipped due to lack comments.