NDoc 1.3.1 SDK

BaseReflectionDocumenterConfig Class

The base config class for documenters which use the ReflectionEngine to extract documentation from .Net assemblies.

For a list of all members of this type, see BaseReflectionDocumenterConfig Members.

System.Object
   NDoc.Core.BaseDocumenterConfig
      NDoc.Core.Reflection.BaseReflectionDocumenterConfig

[Visual Basic]
MustInherit Public Class BaseReflectionDocumenterConfig
    Inherits BaseDocumenterConfig
[C#]
public abstract class BaseReflectionDocumenterConfig : BaseDocumenterConfig
[C++]
public __gc __abstract class BaseReflectionDocumenterConfig : public BaseDocumenterConfig
[JScript]
public  class BaseReflectionDocumenterConfig extends BaseDocumenterConfig

Thread Safety

Public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

Remarks

Generating the documentation consists of two high level steps:

  1. Merging the /doc XML summary with reflected meta-data from the assemblies.
  2. Transforming that merged XML into the documentation (HTML for the MSDN and VS.NET documenters).

The settings below govern how exactly the XML summary data is merged with the reflected meta-data and therefore govern what items will and will not appear in the final documentation.

Requirements

Namespace: NDoc.Core.Reflection

Assembly: NDoc.Core (in NDoc.Core.dll)

See Also

BaseReflectionDocumenterConfig Members | NDoc.Core.Reflection Namespace