How to describe the names in the xml of the class library
-
I'm building documentation for my library with a tool.
Sandcastle Help File Builder GUI
♪ All methods, properties, etc., have been described through XML comments of the document. But one thing I don't know how to describe is the space of names, I can't find where and how to describe it, please.
-
The Nymspeys has an empty class with the name NamespaceDoc, his XML-documentation is considered to be a documentary for the area of the name. This class also has an attribute.
[CompilerGenerated]
so he doesn't get into the documentation himself.namespace Some.Test { /// <summary> /// The <see cref="Some.Test"/> namespace contains classes for .... /// </summary> [System.Runtime.CompilerServices.CompilerGenerated] class NamespaceDoc { } }
http://shfb.codeplex.com/workitem/15516
If you're using Sandcastle Help File Builder, he's got a dialogue in his menus to get the descriptions of the nemspeis.