BaseReflectionDocumenterConfig.UseNamespaceDocSummaries Property

Gets or sets the UseNamespaceDocSummaries property.

[Visual Basic]
<Category(Category:="Documentation Main Settings"), _
 Description(Description:="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary.  The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies."), _
 DefaultValue(Value:=False)>
Public Property UseNamespaceDocSummaries As Boolean
[C#]
[Category(Category="Documentation Main Settings")]
[Description(Description="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary.  The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.")]
[DefaultValue(Value=False)]
public bool UseNamespaceDocSummaries { get; set; }
[C++]
[Category(Category="Documentation Main Settings")]
[Description(Description="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary.  The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.")]
[DefaultValue(Value=False)]
public: __property bool get_UseNamespaceDocSummaries();
public: __property void set_UseNamespaceDocSummaries(bool );
[JScript]
public 
   Category(Category="Documentation Main Settings")
   Description(Description="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary.  The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.")
   DefaultValue(Value=False)
function get UseNamespaceDocSummaries() : bool
public 
   Category(Category="Documentation Main Settings")
   Description(Description="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary.  The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.")
   DefaultValue(Value=False)
function set UseNamespaceDocSummaries(bool);

Remarks

If true, the documenter will look for a class with the name NamespaceDoc in each namespace. The summary from that class will then be used as the namespace summary. The class itself will not show up in the resulting documentation output.

You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.

See Also

BaseReflectionDocumenterConfig Class | NDoc.Core.Reflection Namespace