Class GenDocFXProps

Container of properties for classes implementing GenDocFX The OutputYml and DocFxJsonPath settings are used only when there are manually written MD files that should also be included in the documentation. In other words, the developer has:

  • Defined the documentation directory structure
  • Created a docfx.json file outlining all the rules
  • Written their own MD files
  • Specified where to place the YML files generated by the build system
Inheritance
object
GenDocProps
GenDocFXProps
Implements
Inherited Members
Namespace: BuildSystem.GenDoc.DocFX
Assembly: BuildSystem.GenDoc.DocFX.dll
Syntax
public class GenDocFXProps : GenDocProps, IGenDocProps, IManagerProp

Constructors

GenDocFXProps()

Container of properties for classes implementing GenDocFX

Declaration
public GenDocFXProps()

GenDocFXProps(IManagerProp)

Container of properties for classes implementing GenDocFXProps

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

Fields

NodeDocFxJsonPath

Node key in JSON with properties - value for DocFxJsonPath

Declaration
public const string NodeDocFxJsonPath = "docfx_json_path"
Field Value
Type Description
string

NodeOutputYml

Node key in JSON with properties - value for OutputYml

Declaration
public const string NodeOutputYml = "output_yml"
Field Value
Type Description
string

Properties

DocFxJsonPath

Path to docfx.json file with properties of DocFX run

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

OutputYml

Full path to temporary YML files as result of DocFX metadata command

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

Methods

ApplyConstants(IDictionaryStringString)

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

Clone()

Declaration
public override IManagerProp Clone()
Returns
Type Description
IManagerProp
Overrides

Copy(IManagerProp)

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

EmptyValues()

Declaration
public override void EmptyValues()
Overrides

Update(string, string)

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

Implements