Configuration parameters
GenerateXMLCommentsOnBuild
If set to true, the add-in will generate the XML comments file during build of the project if it is activated for the project and active in the current project configuration
GenerateStubsAutomaticaly
If set to true, the add-in will make ''' autoexpand to a XML documentation stub when typing in a code window. This setting also activates that the add-in will insert ''' at the start of a new line if is pressed inside a XML comment block
XMLCommentPrefix
This setting controls the prefix comments should have in order to be recognised as XML comments. (the prefix includes the start-comment ' symbol
CharsToStripFromRegularComment
If LookForRegularCommentIfNoXMLCommentFound is set to true the characters set in this setting will be removed from the start of the line if the comment is a regular comment
VBXMLDocActive
If set to false this setting disables all functionality the VBXMLDoc add-in provides. (The extra properties in the property explorer will not be removed before VS.NET is restarted and the menu items will not be removed)
LookForRegularCommentIfNoXMLCommentFound
If this setting is set to true and the add-in is unable to locate an XML comment for a type/method it will look for a regular comment instead and place around it if it does not contain any XML tags
GenerateExtraXMLFileInProjectDirectory
If set to true VBXMLDoc will generate a XML file in the project directory in addition to the output directory where the output asembly is placed
ProcessXMLIncludes
If set to true the add-in will look inside XML comments for the include tag and process any include tags it finds. If set to false it will leave the include tags as they are in the XML comments. This setting requires that PerformSimpleValidation is set to true. See MSDN for more information about the include tags.
PerformSimpleValidation
If set to true a simple validation of the XML content of the tag will be performed. The validation only checks that the XML is valid XML, it does not check against any schema.
GenerateSimpleAssemblyHeader
If set to true the output XML file will only contain a simple assembly header (not full name). If set to false and the add-in is unable to retrieve the long name a warning is issued and the short name is used instead.
ShowWarningForMissingComments
If set to true the add-in generates a warning for all missing comments. The warnings is output to the build pane and in addition to the task list if that feature is activated.
AddWarningsToTaskList
If set to true the add-in will add a task to the tasklist for each warning generated that is tied to a method/type.
FollowNestedClasses
If set to true the add-in will look for nested classes
GenerateNotDocumentedComments
If set to true, the add-in will output a not-documented comment in the XML file if no comment is found or the comment contains an error and validation is active.
ShowTasklistOnCompile
If set to true, the add-in will show the tasklist during the build comment file process
ShowBuildpaneOnGenerateComments
If set to true, the add-in will show the buildpane during the build comment file process
MinimumClassVisibility
Controls the minimum visibility a class must have in order to make the add-in check for and/or output an XML comment for it.
MinimumMethodVisibility
Controls the minimum visibility a method must have in order to make the add-in check for and/or output an XML comment for it.
MinimumEventVisibility
Controls the minimum visibility a event must have in order to make the add-in check for and/or output an XML comment for it.
MinimumPropertyVisibility
Controls the minimum visibility a property must have in order to make the add-in check for and/or output an XML comment for it.
MinimumDelegateVisibility
Controls the minimum visibility a delegate must have in order to make the add-in check for and/or output an XML comment for it.
MinimumEnumVisibility
Controls the minimum visibility a enum must have in order to make the add-in check for and/or output an XML comment for it.
MinimumInterfaceVisibility
Controls the minimum visibility a interface must have in order to make the add-in check for and/or output an XML comment for it.
MinimumStructVisibility
Controls the minimum visibility a struct must have in order to make the add-in check for and/or output an XML comment for it.
MinimumTypeVisibility
Controls the minimum visibility a type must have in order to make the add-in check for and/or output an XML comment for it.
MinimumVariableVisibility
Controls the minimum visibility a variable must have in order to make the add-in check for and/or output an XML comment for it.
Tor-Erik Hagen © 2002-2003