interface ITypeDocNode in Tinman.Core.Config.Docs

Defines the documentation content for an ConfigType.

interface	ITypeDocNode	extends	IConfigDocNode
			IContentNode<IBlockNode>
		base of	TypeDocNode

Attributes

Content

The content nodes.

property	Content { get }
type	IVectorConst<T>
value	[not-null]	The content nodes.
inherited	IContentNode.Content

IsEmpty

Is this document node empty (i.e. it contains whitespace only)?

property	IsEmpty { get }
type	bool
value		true if this document node is empty, false if not.
inherited	IDocumentNode.IsEmpty

Members

The member documentation nodes.

property	Members { get }
type	IVectorConst<IMemberDocNode>
value	[not-null]	The content nodes.

Name

The type name.

property	Name { get }
type	string
value	[not-null]	The type name.

See also:

ConfigType.Get

SerialType

Returns the serial type of this object.

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

SerialVersion

Returns the serial data version.

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

Remarks:

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

See also:

ISerializable.Serialize
ISerializable.Deserialize

Methods

Accept

Accepts the given node visitor.

method	Accept (IConfigDocNodeVisitor visitor, object userData)
params	visitor		The visitor to accept. If null the method shall return silently.
	userData		Optional user data object.
inherited	IConfigDocNode.Accept

---

Accepts the given node visitor.

method	Accept (IDocumentNodeVisitor visitor, object userData)
params	visitor		The visitor to accept. If null the method shall return silently.
	userData		Optional user data object.
inherited	IDocumentNode.Accept

AcceptContent

Calls Accept on each content node.

method	AcceptContent (IDocumentNodeVisitor visitor, object userData)
params	visitor		The visitor to accept. If null the method returns silently.
	userData		Optional user data object.
inherited	IContentNode.AcceptContent

Deserialize

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

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).
inherited	ISerializable.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

GetDocumentationFor

Returns the documentation for the given config field.

method	GetDocumentationFor (string field)
type	IMemberDocNode
params	field	[not-null]	The config field name.
returns			The documentation or null if not found.

Serialize

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

method	Serialize (ISerializer data)
params	data	[not-null]	The serial data stream.
inherited	ISerializable.Serialize

See also:

ISerializable.Deserialize
ISerializable.SerialVersion

Validate

Validates the state of this object.

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

WriteSourceCode

Produces source code by feeding the given source code writer.

method	WriteSourceCode (SourceCodeWriter writer, Context context)
params	writer	[not-null]	The source code writer to use.
	context	[not-null]	Context information.
inherited	ICodeOutput.WriteSourceCode