NDoc 1.3.1 SDK

BaseReflectionDocumenterConfig.ShowMissingSummaries Property

Gets or sets the ShowMissingSummaries property.

[Visual Basic]
<Description(Description:="Turning this flag on will show you where you are missing summaries."), _  Category(Category:="Show Missing Documentation"), _  DefaultValue(Value:=False)>
Public Property ShowMissingSummaries As Boolean [C#]
[Description(Description="Turning this flag on will show you where you are missing summaries.")]
[Category(Category="Show Missing Documentation")]
[DefaultValue(Value=False)]
public bool ShowMissingSummaries { get; set; } [C++]
[Description(Description="Turning this flag on will show you where you are missing summaries.")]
[Category(Category="Show Missing Documentation")]
[DefaultValue(Value=False)]
public: __property bool get_ShowMissingSummaries(); public: __property void set_ShowMissingSummaries(bool ); [JScript] public 
   Description(Description="Turning this flag on will show you where you are missing summaries.")
   Category(Category="Show Missing Documentation")
   DefaultValue(Value=False)
function get ShowMissingSummaries() : bool public 
   Description(Description="Turning this flag on will show you where you are missing summaries.")
   Category(Category="Show Missing Documentation")
   DefaultValue(Value=False)
function set ShowMissingSummaries(bool);

Remarks

If this is true, all members without /doc <summary> comments will contain the phrase Missing Documentation in the generated documentation.

See Also

BaseReflectionDocumenterConfig Class | NDoc.Core.Reflection Namespace