Generates documentation from reflection data. More...

Inheritance diagram for Nuke.Unreal.Tools.UbtConfigGenerated.WriteDocumentationConfig:

Public Member Functions
virtual WriteDocumentationConfig	_Type (DocumentationType? val=null)
	Type of documentation to generate REQUIRED!

virtual WriteDocumentationConfig	OutputFile (object val=null)
	The HTML file to write to REQUIRED!

Public Member Functions inherited from Nuke.Unreal.Tools.ToolConfig
virtual void	AppendArgument (UnrealToolArgument arg)

virtual void	AppendArgument (string arg, UnrealToolArgumentMeta? meta=null)

virtual void	AppendSubtool (ToolConfig subtool)

virtual string	Gather (EngineVersion ueVersion)
	Gether the arguments and subtools and render a command line output.

Properties
override string	Name `[get]`

override string	CliName `[get]`

override UnrealCompatibility	Compatibility `[get]`

override ToolConfig[]	Configs `[get]`

Properties inherited from Nuke.Unreal.Tools.ToolConfig
string	Name `[get]`
	The C# friendly name of the tool which will be used inside configurators.

string	CliName `[get]`
	The name which will be rendered onto command line.

UnrealCompatibility	Compatibility `[get]`
	Compatibility with either Unreal Engine 4 or 5 or both. If tool is configured to run with an incompatible engine its entire configuration will be ignored.

virtual ToolConfig[]	Configs `[get]`

Private Attributes
ToolConfig[]	_configs = null

Additional Inherited Members
Protected Attributes inherited from Nuke.Unreal.Tools.ToolConfig
List< UnrealToolArgument >	UsingArguments = []

readonly Dictionary< string, ToolConfig >	UsingSubtools = []

Detailed Description

Generates documentation from reflection data.

Definition at line 14952 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ _Type()

virtual WriteDocumentationConfig Nuke.Unreal.Tools.UbtConfigGenerated.WriteDocumentationConfig._Type ( DocumentationType? val = null )

virtual

Type of documentation to generate REQUIRED!

Definition at line 14960 of file UbtConfigGenerated.cs.

◆ OutputFile()

virtual WriteDocumentationConfig Nuke.Unreal.Tools.UbtConfigGenerated.WriteDocumentationConfig.OutputFile ( object val = null )

virtual

The HTML file to write to REQUIRED!

Definition at line 14980 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.WriteDocumentationConfig._configs = null

private

Definition at line 14998 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UbtConfigGenerated.WriteDocumentationConfig.CliName

get

Definition at line 14955 of file UbtConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UbtConfigGenerated.WriteDocumentationConfig.Compatibility

get

Definition at line 14956 of file UbtConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.WriteDocumentationConfig.Configs

getprotected

Definition at line 14999 of file UbtConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UbtConfigGenerated.WriteDocumentationConfig.Name

get

Definition at line 14954 of file UbtConfigGenerated.cs.

The documentation for this class was generated from the following file:

/home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/Tools/UbtConfigGenerated.cs

Public Member Functions

Properties

Private Attributes

Additional Inherited Members