Avoid Private method from Documentation

[fire-cloud-apps]

Thanks for this nice package.

Is there any way to avoid private method from documenting?

[astrohart]

I would say, just don't add XML doc comments to the method you do not want to document.

[haegelixatwork]

+1

Would be nice if there was the possibility to exclude private & internal methods. This way...

• programmers developing the library have their IDE help them out with the documentation.
• the external API (public, protected, ... stuff) can be documented properly in markdown for others to use it.

[astrohart]

Better yet, make this an option.

[astrohart]

I strongly advocate for making such behavior configurable.  The reason being, is that I myself, want to make my private and internal members documented in .md for my own, private GitHub repositories, so I can remember what code I wrote, and why.  

 

Perhaps another developer may want to turn this behavior "on" for their public repos (not document private and/or internal members) and "off" for their private repos.

 

Regards,

 

 

Brian Hart

On 12/15/2022 7:21 AM MST haegelixatwork ***@***.***> wrote:

 

 

  +1 Would be nice if there was the possibility to exclude private & internal methods.This way...

programmers developing the library have their IDE help them out with the documentation. 
the external API (public, protected, ... stuff) can be documented properly in markdown for others to use it. 

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you commented.Message ID: @.***>