Documenting fields and internals
Question asked by Mascaro Angelo - October 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
0
Misha Zhutov Replied
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.
0
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.

0
Misha Zhutov Replied
Employee Post
That option is only available in Pro version. In free version only public members are included into help file.
0
Yes, now I'm evaluating the Pro version.
0
Hi Misha
how can I mark this question as answered?
0
Misha Zhutov Replied
Employee Post
Please find "Post Reply" below with arrow down, click on the arrow and choose "as the answer"
0
Serge B. Replied
Employee Post Marked As Answer
That option is only available in the Pro version. In the free version only public members are included into the generated help documentation.
Serge Baranovsky
SubMain Software
(800) 936-2134

Reply to Thread