NDoc 1.3.1 SDK

BaseReflectionDocumenterConfig.DocumentedAttributes Property

Gets or sets which attributes should be documented.

[Visual Basic]
<Category(Category:="Show Attributes"), _  Editor(EditorBaseTypeName:="System.Drawing.Design.UITypeEditor, System.Drawing, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName:="NDoc.Core.PropertyGridUI.AttributesEditor, NDoc.Core, Version=1.3.1851.0, Culture=neutral, PublicKeyToken=b9896512f28c0f09"), _  DefaultValue, _  Description(Description:="When DocumentAttributes is set to true, this specifies which attributes/property are visible. Empty to show all. Format: '<attribute-name-starts-with>,<property-to-show>,<property-to-show>|<attribute-name-starts-with>,<property-to-show>,<property-to-show>|(etc...)'.")>
Public Property DocumentedAttributes As String [C#]
[Category(Category="Show Attributes")]
[Editor(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="NDoc.Core.PropertyGridUI.AttributesEditor, NDoc.Core, Version=1.3.1851.0, Culture=neutral, PublicKeyToken=b9896512f28c0f09")]
[DefaultValue]
[Description(Description="When DocumentAttributes is set to true, this specifies which attributes/property are visible. Empty to show all. Format: '<attribute-name-starts-with>,<property-to-show>,<property-to-show>|<attribute-name-starts-with>,<property-to-show>,<property-to-show>|(etc...)'.")]
public string DocumentedAttributes { get; set; } [C++]
[Category(Category="Show Attributes")]
[Editor(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="NDoc.Core.PropertyGridUI.AttributesEditor, NDoc.Core, Version=1.3.1851.0, Culture=neutral, PublicKeyToken=b9896512f28c0f09")]
[DefaultValue]
[Description(Description="When DocumentAttributes is set to true, this specifies which attributes/property are visible. Empty to show all. Format: '<attribute-name-starts-with>,<property-to-show>,<property-to-show>|<attribute-name-starts-with>,<property-to-show>,<property-to-show>|(etc...)'.")]
public: __property String* get_DocumentedAttributes(); public: __property void set_DocumentedAttributes(String* ); [JScript] public 
   Category(Category="Show Attributes")
   Editor(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="NDoc.Core.PropertyGridUI.AttributesEditor, NDoc.Core, Version=1.3.1851.0, Culture=neutral, PublicKeyToken=b9896512f28c0f09")
   DefaultValue
   Description(Description="When DocumentAttributes is set to true, this specifies which attributes/property are visible. Empty to show all. Format: '<attribute-name-starts-with>,<property-to-show>,<property-to-show>|<attribute-name-starts-with>,<property-to-show>,<property-to-show>|(etc...)'.")
function get DocumentedAttributes() : String public 
   Category(Category="Show Attributes")
   Editor(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="NDoc.Core.PropertyGridUI.AttributesEditor, NDoc.Core, Version=1.3.1851.0, Culture=neutral, PublicKeyToken=b9896512f28c0f09")
   DefaultValue
   Description(Description="When DocumentAttributes is set to true, this specifies which attributes/property are visible. Empty to show all. Format: '<attribute-name-starts-with>,<property-to-show>,<property-to-show>|<attribute-name-starts-with>,<property-to-show>,<property-to-show>|(etc...)'.")
function set DocumentedAttributes(String);

Remarks

When DocumentAttributes is set to true, this specifies which attributes/property are visible. Empty to show all.

Format: '<attribute-name-starts-with>,<property-to-show>,<property-to-show>| <attribute-name-starts-with>,<property-to-show>,<property-to-show>|(etc...)'.

See Also

BaseReflectionDocumenterConfig Class | NDoc.Core.Reflection Namespace