Hello. I'm having good success documenting all the classes and methods in a DLL. I tell NDocs to complain when there's no summary -- normally a good thing -- but then at the top of the generated documentation, NDocs complains that the library itself is missing the summary. I'd like to provide it, but where do I enter it? Thanks.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I'll answer this myself. Press the NameSpace summary button on the NDoc screen. We would prefer, though, that this text could be saved inside the sourcecode itself.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Look up the help for the option UseNamespaceDocSummaries
If true, the documenter will look for a class with the name NamespaceDoc in each namespace. The summary from that class will then be used as the namespace summary. The class itself will not show up in the resulting documentation output.
You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hello. I'm having good success documenting all the classes and methods in a DLL. I tell NDocs to complain when there's no summary -- normally a good thing -- but then at the top of the generated documentation, NDocs complains that the library itself is missing the summary. I'd like to provide it, but where do I enter it? Thanks.
I'll answer this myself. Press the NameSpace summary button on the NDoc screen. We would prefer, though, that this text could be saved inside the sourcecode itself.
Look up the help for the option UseNamespaceDocSummaries
If true, the documenter will look for a class with the name NamespaceDoc in each namespace. The summary from that class will then be used as the namespace summary. The class itself will not show up in the resulting documentation output.
You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.