VSdocman Help  

Members Compile Options

Go to Add-Ins -> VSdocman menu or press VSdocman button on standard toolbar. Options dialog appears. Set Compile - Members page.

 

 

Compile also non-commented members

Compile also members without special XML or @-style comments. The default comment is then assumed. Member acts as if there was a comment added using Add XML Comment function from pop-up menu and nothing else was added.

Accessibility

Check which members with accessibility modifiers will be compiled. Only members with checked accessibility will be compiled. If you create class library or control documentation for end user you usually need to document only public members.

Members

Specify which members (classes, forms, methods, events, ...) go to the compilation. Options serve as a filter here.

Option Meaning
Classes Include topics for classes (objects). If unchecked, not only topics for classes won't be generated, but also their members such as methods or events will not be included.
Forms Include topics for form classes. If unchecked, not only topics for form classes won't be generated, but also their members such as methods or events will not be included.
Modules Applies to VB. Include topics for modules. If unchecked, not only topics for modules won't be generated, but also their members such as functions and variables will not be included.Modules are listed as NonInheritable classes with all members set as Shared in the final documentation.
Methods/Functions Include topics for methods and functions.
Properties Include topics for properties.
Events Include topics for events.
Variables Include topics for variables.
Interfaces Include topics for interfaces. If unchecked, not only topics for interfaces won't be generated, but also their members such as methods or events will not be included.

Structures

Include topics for structures. If unchecked, not only topics for structures won't be generated, but also their members such as methods or variables will not be included.
Enumerations Include topics for enumerations. Note, if you want to list complete enumeration with its constants in documentation you must also check to compile Constants.
Declares Include topics for declares in VB (external functions in C#).
Delegates Include topics for delegates.
Constants Include topics for constants.

 

List forms under separate category

If you view topic for namespace and click to namespace members page you see all members of that namespace grouped by type: classes, interfaces, enumerations etc. By default all classes that are form (i.e. they inherit from Form class) are listed under classes. If you check this option, forms will be listed in separate Forms category instead of Classes.

List inherited members

If you view topic for class and click to class members page you see all members of that class grouped by type: constructors, methods, properties etc. If this option is unchecked you only see the members that are explicitly defined in this class. If you check this option you will see also all inherited members. These members are marked as inherited.

See Also

VSdocman Options