Extensibility Sections

NDoc3

Extensibility Sections

Below are the names of the documentation sections where custom tags can be displayed. These names are used as the mode attribute in extensibility stylesheet templates.

Section Name Description
header-section Templates in the header-section will be output within the html <head> tag.
preliminary-section This is the notification that it output for items marked with the <preliminary> tag or projects compiled with the Preliminary setting equal to true.
summary-section The section corresponding to the <summary> tag.
thread-safety-section The section where thread safety information is displayed.
syntax-section The section where item syntax is displayed.
value-section The section corresponding to the <value> tag.
parameter-section The section corresponding to the <param> tag.
returnvalue-section The section corresponding to the <returns> tag.
implements-section  
remarks-section The section corresponding to the <remarks> tag.
after-remarks-section A section after the section corresponding to the <remarks> tag.

Note: This extension section will be processed regardless of whether <remarks> exist or not...

obsolete-section The section denoting that an item is decorated with the ObsoleteAttribute.
events-section The section corresponding to the <event> tag.
exceptions-section The section corresponding to the <exception> tag.
example-section The section corresponding to the <example> tag.
member-requirements-section  
type-requirements-section  
seealso-section The list of See Also links at the bottom of a topic.
enumeration-members-section The section where an enumeration's members are listed.
footer-row The footer row at the bottom of each topic.
title-row The title row at the top of each topic.
overloads-remarks-section  
overloads-example-section  
overloads-summary-section  
xml-data-island The embedded XML data island used by Html Help 2 to include meta-data about a topic. Applies only to the VS.NET 2003 documenter.

See Also

NDoc3 Extensibility