TypeDocNode

Description

sealed class Tinman.Core.Config.Docs.TypeDocNode

Derived from

ContentNode<IBlockNode> abstract
IConfigDocNode
ICollector<MemberDocNode>

Defines the documentation content for an ConfigType.

Public / Constructors

Type​Doc​Node

2 overloads

public constructor TypeDocNode1 → ()

Creates a new instance of TypeDocNode.

public constructor TypeDocNode2 → (1)

name in : string

[not-null]
The config type name.

Creates a new instance of TypeDocNode.

Public / Methods

Get​Documentation​For

public method GetDocumentationFor → (1)

field in : string

[not-null]
The config field name.

returns → MemberDocNode

The documentation or null if not found.

Returns the documentation for the given config field.

Public / Attributes

Members

public attribute Members → (get)

value : IVectorConst<MemberDocNode>

[not-null]
The content nodes.

The member documentation nodes.

Name

public attribute Name → (get,set)

value : string

[not-null]
The type name.

The type name.

See also

ConfigType.Get

Serialization

Serial​Id

public static readonly attribute SerialId → (ISerialTypeInfo)

Serialization information about this type.