BaseReflectionDocumenterConfig.AutoPropertyBackerSummaries Property

Gets or sets the AutoPropertyBackerSummaries property.

[Visual Basic]
<Category(Category:="Documentation Main Settings"), _
 DefaultValue(Value:=False), _
 Description(Description:="If true, the documenter will automatically add a summary for fields which look like they back (hold the value for) a property. The summary is only added if there is no existing summary, which gives you a way to opt out of this behavior in particular cases. Currently the naming conventions supported are such that fields '_Length' and 'length' will be inferred to back property 'Length'.")>
Public Property AutoPropertyBackerSummaries As Boolean
[C#]
[Category(Category="Documentation Main Settings")]
[DefaultValue(Value=False)]
[Description(Description="If true, the documenter will automatically add a summary for fields which look like they back (hold the value for) a property. The summary is only added if there is no existing summary, which gives you a way to opt out of this behavior in particular cases. Currently the naming conventions supported are such that fields '_Length' and 'length' will be inferred to back property 'Length'.")]
public bool AutoPropertyBackerSummaries { get; set; }
[C++]
[Category(Category="Documentation Main Settings")]
[DefaultValue(Value=False)]
[Description(Description="If true, the documenter will automatically add a summary for fields which look like they back (hold the value for) a property. The summary is only added if there is no existing summary, which gives you a way to opt out of this behavior in particular cases. Currently the naming conventions supported are such that fields '_Length' and 'length' will be inferred to back property 'Length'.")]
public: __property bool get_AutoPropertyBackerSummaries();
public: __property void set_AutoPropertyBackerSummaries(bool );
[JScript]
public 
   Category(Category="Documentation Main Settings")
   DefaultValue(Value=False)
   Description(Description="If true, the documenter will automatically add a summary for fields which look like they back (hold the value for) a property. The summary is only added if there is no existing summary, which gives you a way to opt out of this behavior in particular cases. Currently the naming conventions supported are such that fields '_Length' and 'length' will be inferred to back property 'Length'.")
function get AutoPropertyBackerSummaries() : bool
public 
   Category(Category="Documentation Main Settings")
   DefaultValue(Value=False)
   Description(Description="If true, the documenter will automatically add a summary for fields which look like they back (hold the value for) a property. The summary is only added if there is no existing summary, which gives you a way to opt out of this behavior in particular cases. Currently the naming conventions supported are such that fields '_Length' and 'length' will be inferred to back property 'Length'.")
function set AutoPropertyBackerSummaries(bool);

Remarks

If true, the documenter will automatically add a summary for fields which look like they back (hold the value for) a property. The summary is only added if there is no existing summary, which gives you a way to opt out of this behavior in particular cases. Currently the naming conventions supported are such that fields _Length and length will be inferred to back property Length.

See Also

BaseReflectionDocumenterConfig Class | NDoc.Core.Reflection Namespace