BaseReflectionDocumenterConfig.DocumentPrivates Property

Gets or sets the DocumentPrivates property.

[Visual Basic]
<Description(Description:="Turn this flag on to document private code."), _
 DefaultValue(Value:=False), _
 Category(Category:="Visibility")>
Public Property DocumentPrivates As Boolean
[C#]
[Description(Description="Turn this flag on to document private code.")]
[DefaultValue(Value=False)]
[Category(Category="Visibility")]
public bool DocumentPrivates { get; set; }
[C++]
[Description(Description="Turn this flag on to document private code.")]
[DefaultValue(Value=False)]
[Category(Category="Visibility")]
public: __property bool get_DocumentPrivates();
public: __property void set_DocumentPrivates(bool );
[JScript]
public 
   Description(Description="Turn this flag on to document private code.")
   DefaultValue(Value=False)
   Category(Category="Visibility")
function get DocumentPrivates() : bool
public 
   Description(Description="Turn this flag on to document private code.")
   DefaultValue(Value=False)
   Category(Category="Visibility")
function set DocumentPrivates(bool);

Remarks

If this is true, types and members marked as private will be included in the documentation.

Normally private items are not documented. This is useful when use NDoc to create documentation intended for internal use.

See Also

BaseReflectionDocumenterConfig Class | NDoc.Core.Reflection Namespace