class ConfigDoc in Tinman.Core.Config.Docs

Defines documentation content for ConfigType s.

sealed class	ConfigDoc	implements	IValidatable
		extends	SerializableBase

Serialization

SerialId

Serialization information about this type.

public static readonly field	SerialId
type	ISerialTypeInfo

Public / Attributes

ModuleGuid

public property	ModuleGuid { get }
type	GUID
value

SerialType

Returns the serial type of this object.

public property	SerialType { get }
type	ISerialTypeInfo
value	[not-null]	The serial type.
inherited	SerializableBase.SerialType

SerialVersion

Returns the serial data version.

public virtual property	SerialVersion { get }
type	int32
value	[>=1]	The serial data version tag.
inherited	SerializableBase.SerialVersion

Remarks:

An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.

See also:

ISerializable.Serialize
ISerializable.Deserialize

TypeDocs

public property	TypeDocs { get }
type	IBagConst<ITypeDocNode>
value

Public / Constructors

ConfigDoc

Creates a new instance of ConfigDoc.

public constructor	ConfigDoc (TinmanModule module)
params	module	[not-null]	The module.

Public / Methods

Deserialize

Initializes the state of this object from the given data stream.

public override method	Deserialize (int32 serialVersion, ISerializer data)
type	ISerializable
params	serialVersion	[>=1]	The serial data version.
	data	[not-null]	The serial data stream.
returns		[not-null]	The deserialized object. This will typically be this, but in some circumstances, another instance may be returned (e.g. singletons).
overrides	SerializableBase.Deserialize

Remarks:

The Deserialize method will be called immediately after the object has been instantiated via its default constructor.

The provided serialVersion number is guaranteed to be equal to or less than the SerialVersion returned by this object (i.e. ISerializable object must provide backwards compatibility).

See also:

ISerializable.Serialize
ISerializable.SerialVersion

Get

Returns the documentation for the given type.

public method	Get (string name)
type	ITypeDocNode
params	name	[not-null]	The type name.
returns			The documentation or null.

Load

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

public static method	Load ([Owner] Path path)
params	path	[not-null]	The file to load.

See also:

TinmanModule.ConfigDocumentation

---

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

public static method	Load ([Owner] IDataStream stream)
params	stream	[not-null]	The data to load.

See also:

TinmanModule.ConfigDocumentation

Serialize

Serializes the current state of this object to the given data stream.

public override method	Serialize (ISerializer data)
params	data	[not-null]	The serial data stream.
overrides	SerializableBase.Serialize

See also:

ISerializable.Deserialize
ISerializable.SerialVersion

Validate

Validates the state of this object.

public method	Validate (Validator validator)
params	validator	[not-null]	The validator object.
implements	IValidatable.Validate

Logging

Logger

The logger object of this class.

public static readonly field	Logger
type	ILogger