NaturalDocs / NaturalDocs

Natural Docs source code documentation system
http://www.naturaldocs.org
192 stars 33 forks source link

Is anyway to hide the internel code? #64

Closed fonzieyang closed 3 years ago

fonzieyang commented 3 years ago

I tried all the combinations, but still don't get it.

NaturalDocs commented 3 years ago

I assume you mean you want certain functions and classes to appear in the documentation and others not to?

First, which language are you using? If you're using C# then you need to run Natural Docs with the --documented-only command line option. This means only things you wrote a Natural Docs comment for will be included and everything else won't. If you're using a different language then this is already how it works.

Or do you want one set of internal documentation that includes everything and one which is a subset of it for the public?

fonzieyang commented 3 years ago

thanks for answering, I want to hide the privide field, and I'm using C#

NaturalDocs commented 3 years ago

Right now that's the only option for filtering, documented vs undocumented. Being able to filter by access level like public vs protected vs private is something I want to add but it isn't implemented yet and it will probably be a while before it is.