Class GenDocProps

Container of properties for classes implementing IGenDoc

Inheritance
object
GenDocProps
GenDocFXProps
Implements
Namespace: BuildSystem.Factories
Assembly: BuildSystem.Factories.dll
Syntax
public class GenDocProps : Object, IGenDocProps, IManagerProp

Constructors

GenDocProps()

Container of properties for classes implementing IGenDoc

Declaration
public GenDocProps()

GenDocProps(IManagerProp)

Container of properties for classes implementing IGenDoc

Declaration
public GenDocProps(IManagerProp source)
Parameters
Type Name Description
IManagerProp source

Fields

ClassIdent

Ident for factory

Declaration
public const string ClassIdent = "GenDoc"
Field Value
Type Description
string

NodeIncludeRefProjects

Node key in JSON with properties - value for IncludeRefProjects

Declaration
public const string NodeIncludeRefProjects = "include_ref_projects"
Field Value
Type Description
string

NodeIncludes

Node key in JSON with properties - value for Includes

Declaration
public const string NodeIncludes = "includes"
Field Value
Type Description
string

NodeName

Node key in JSON with properties - value for Name

Declaration
public const string NodeName = "name"
Field Value
Type Description
string

Properties

IncludeRefProjects

Include project references in generating documentation

Declaration
public bool IncludeRefProjects { get; set; }
Property Value
Type Description
bool

Includes

List of additional files, which should be included in process on generation documentation

Declaration
public Dictionary<string, ReaderType> Includes { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<,><string, ReaderType>

ManagerType

Declaration
public ManagerType ManagerType { get; }
Property Value
Type Description
ManagerType

Name

Declaration
public string Name { get; set; }
Property Value
Type Description
string

Methods

ApplyConstants(IDictionaryStringString)

Declaration
public virtual void ApplyConstants(IDictionaryStringString constants)
Parameters
Type Name Description
IDictionaryStringString constants

Clone()

Declaration
public virtual IManagerProp Clone()
Returns
Type Description
IManagerProp

Copy(IManagerProp)

Declaration
public virtual void Copy(IManagerProp source)
Parameters
Type Name Description
IManagerProp source

EmptyValues()

Declaration
public virtual void EmptyValues()

Update(string, string)

Declaration
public virtual void Update(string jsonInfo, string relativeDir)
Parameters
Type Name Description
string jsonInfo
string relativeDir

Implements