ConfigDoc

Description

sealed class Tinman.Core.Config.Docs.ConfigDoc

Derived from

SerializableBase abstract
IValidatable

Defines documentation content for ConfigTypes.

Public / Constructors

ConfigDoc


public constructor ConfigDoc → (1)

module in : TinmanModule

[not-null]
The module.

Creates a new instance of ConfigDoc.

Public / Methods

Get


public method Get → (1)

name in : string

[not-null]
The type name.

returns → TypeDocNode

The documentation or null.

Returns the documentation for the given type.

Load

2 overloads


public static method Load1 → (1)

path in : Path

[not-null]
The file to load.

Loads the given config documentation file (*.BCD).

IOException

If an I/O error has occurred.


public static method Load2 → (1)

stream in : IDataStream

[not-null]
The data to load.

Loads the given config documentation file (*.BCD).

IOException

If an I/O error has occurred.

Public / Attributes

ModuleGuid


public attribute ModuleGuid → (get)

value : GUID

The module identifier.

Returns the module identifier.

TypeDocs


public attribute TypeDocs → (get)

value : IBagConst<TypeDocNode>

[not-null]
The TypeDocNode objects.

Returns the type documentation content.

Logging

Logger


public static readonly attribute Logger → (ILogger)

The logger object of this class.

Serialization

SerialId


public static readonly attribute SerialId → (ISerialTypeInfo)

Serialization information about this type.