BaseReflectionDocumenterConfig.Preliminary Property

Get/set the Preliminary preoperty

[Visual Basic]
<Category(Category:="Documentation Main Settings"), _
 Description(Description:="If true, NDoc will mark every topic as being preliminary documentation."), _
 DefaultValue(Value:=False)>
Public Property Preliminary As Boolean
[C#]
[Category(Category="Documentation Main Settings")]
[Description(Description="If true, NDoc will mark every topic as being preliminary documentation.")]
[DefaultValue(Value=False)]
public bool Preliminary { get; set; }
[C++]
[Category(Category="Documentation Main Settings")]
[Description(Description="If true, NDoc will mark every topic as being preliminary documentation.")]
[DefaultValue(Value=False)]
public: __property bool get_Preliminary();
public: __property void set_Preliminary(bool );
[JScript]
public 
   Category(Category="Documentation Main Settings")
   Description(Description="If true, NDoc will mark every topic as being preliminary documentation.")
   DefaultValue(Value=False)
function get Preliminary() : bool
public 
   Category(Category="Documentation Main Settings")
   Description(Description="If true, NDoc will mark every topic as being preliminary documentation.")
   DefaultValue(Value=False)
function set Preliminary(bool);

Remarks

If true, NDoc will mark every topic as being preliminary documentation. Each topic will include a notice that the documentation is preliminary

The default notice is [This is preliminary documentation and subject to change.]

See Also

BaseReflectionDocumenterConfig Class | NDoc.Core.Reflection Namespace