NDoc 1.3.1 SDK

BaseReflectionDocumenterConfig.AutoDocumentConstructors Property

Gets or sets the AutoDocumentConstructors property.

[Visual Basic]
<DefaultValue(Value:=True), _  Category(Category:="Documentation Main Settings"), _  Description(Description:="Turning this flag on will enable automatic summary documentation for default constructors.")>
Public Property AutoDocumentConstructors As Boolean [C#]
[DefaultValue(Value=True)]
[Category(Category="Documentation Main Settings")]
[Description(Description="Turning this flag on will enable automatic summary documentation for default constructors.")]
public bool AutoDocumentConstructors { get; set; } [C++]
[DefaultValue(Value=True)]
[Category(Category="Documentation Main Settings")]
[Description(Description="Turning this flag on will enable automatic summary documentation for default constructors.")]
public: __property bool get_AutoDocumentConstructors(); public: __property void set_AutoDocumentConstructors(bool ); [JScript] public 
   DefaultValue(Value=True)
   Category(Category="Documentation Main Settings")
   Description(Description="Turning this flag on will enable automatic summary documentation for default constructors.")
function get AutoDocumentConstructors() : bool public 
   DefaultValue(Value=True)
   Category(Category="Documentation Main Settings")
   Description(Description="Turning this flag on will enable automatic summary documentation for default constructors.")
function set AutoDocumentConstructors(bool);

Remarks

Turning this flag on will enable automatic summary documentation for default constructors. If no summary for a parameter-less constructor is present, the default constructor summary of Initializes a new instance of the CLASSNAME class is inserted.

See Also

BaseReflectionDocumenterConfig Class | NDoc.Core.Reflection Namespace