NDoc 1.3.1 SDK

BaseReflectionDocumenterConfig.ShowMissingRemarks Property

Gets or sets the ShowMissingRemarks property.

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

Remarks

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

See Also

BaseReflectionDocumenterConfig Class | NDoc.Core.Reflection Namespace