Documenting fields and internals

Question asked by Mascaro Angelo - 10/30/2018 at 7:40 AM

Answered

I'm personally testing ghostdoc because I'd like to introduce it in the company where I work. This company needs to document its software, but not because they sell libraries or need to supply the documentation. They, or better said we, need to document the software for the developers. So we need to document also internal classes and fields. I tried and I seached option to do that, but I didn't succeed. Is it possible or this is something that GhostDoc doesn't allow?

7 Replies

Reply to Thread

Misha Zhutov Replied

10/31/2018 at 3:27 AM

Employee Post

Hello,

Yes, it is possible to document internal/private members and include them into help file.
You can find all options in Tools->GhostDoc->Options->General (Scope for Document File/Type) and Tools->GhostDoc->Build Help Documentation dialog.

Mascaro Angelo Replied

11/5/2018 at 11:00 PM

Thanks!
I tried it immediately, but there is no such an option "Scope for Document File/Type" in the General Option dialog and the options in Tools->GhostDoc->Build Help Documentation dialog are disabled, available only in the Pro version, so I can't perform the test.
I will check later if a trial period for the Pro version exists.