loxsmoke / mddox

Markdown documentation generator tool
MIT License
37 stars 10 forks source link

[Feature Request] Option for ignoring types without documentation #17

Closed ModernRonin closed 3 years ago

ModernRonin commented 4 years ago

Hi,

thanks for a super cool tool!

One thing that would be helpful would be a command-line switch that tells mddox to ignore types that have no comments.

Would that be hard to do?

Thanks, MR

loxsmoke commented 4 years ago

Currently, the easiest solution is to add an attribute to the class and use --ignore-attribute option when generating the documentation. See if that helps.

loxsmoke commented 3 years ago

Closing this. There is a simple workaround that is not elegant. Adding multiple ignore options would make tool much more complicated.