Nuke.Unreal.Tools.UbtConfigGenerated.GenerateClangDatabaseConfig Class Reference

Generate a clang compile_commands file for a target. More...

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

Public Member Functions
virtual GenerateClangDatabaseConfig	Filter (params object[] values)
	Set of filters for files to include in the database. Relative to the root directory, or to the project file.
virtual GenerateClangDatabaseConfig	ExecCodeGenActions (bool? val=null)
	Execute any actions which result in code generation (eg. ISPC compilation)
virtual GenerateClangDatabaseConfig	NoExecCodeGenActions (bool present=true)
	Execute any actions which result in code generation (eg. ISPC compilation)
virtual GenerateClangDatabaseConfig	Include (params object[] values)
	Optional set of source files to include in the compile database. If this is empty, all files will be included by default and -Exclude can be used to exclude some. Relative to the root directory, or to the project file.
virtual GenerateClangDatabaseConfig	Exclude (params object[] values)
	Optional set of source files to exclude from the compile database. Relative to the root directory, or to the project file.
virtual GenerateClangDatabaseConfig	OutputFilename (object val=null)
	Optionally override the output filename for handling multiple targets.
virtual GenerateClangDatabaseConfig	OutputDir (object val=null)
	Optionally overrite the output directory for the compile_commands file.
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

Generate a clang compile_commands file for a target.

Definition at line 13932 of file UbtConfigGenerated.cs.

Member Function Documentation

Exclude()

virtual GenerateClangDatabaseConfig Nuke.Unreal.Tools.UbtConfigGenerated.GenerateClangDatabaseConfig.Exclude ( params object[] values )

virtual

Optional set of source files to exclude from the compile database. Relative to the root directory, or to the project file.

Definition at line 14035 of file UbtConfigGenerated.cs.

ExecCodeGenActions()

virtual GenerateClangDatabaseConfig Nuke.Unreal.Tools.UbtConfigGenerated.GenerateClangDatabaseConfig.ExecCodeGenActions ( bool? val = null )

virtual

Execute any actions which result in code generation (eg. ISPC compilation)

Definition at line 13966 of file UbtConfigGenerated.cs.

Filter()

virtual GenerateClangDatabaseConfig Nuke.Unreal.Tools.UbtConfigGenerated.GenerateClangDatabaseConfig.Filter ( params object[] values )

virtual

Set of filters for files to include in the database. Relative to the root directory, or to the project file.

Definition at line 13941 of file UbtConfigGenerated.cs.

Include()

virtual GenerateClangDatabaseConfig Nuke.Unreal.Tools.UbtConfigGenerated.GenerateClangDatabaseConfig.Include ( params object[] values )

virtual

Optional set of source files to include in the compile database. If this is empty, all files will be included by default and -Exclude can be used to exclude some. Relative to the root directory, or to the project file.

Definition at line 14009 of file UbtConfigGenerated.cs.

NoExecCodeGenActions()

virtual GenerateClangDatabaseConfig Nuke.Unreal.Tools.UbtConfigGenerated.GenerateClangDatabaseConfig.NoExecCodeGenActions ( bool present = true )

virtual

Execute any actions which result in code generation (eg. ISPC compilation)

Definition at line 13987 of file UbtConfigGenerated.cs.

OutputDir()

virtual GenerateClangDatabaseConfig Nuke.Unreal.Tools.UbtConfigGenerated.GenerateClangDatabaseConfig.OutputDir ( object val = null )

virtual

Optionally overrite the output directory for the compile_commands file.

Definition at line 14081 of file UbtConfigGenerated.cs.

OutputFilename()

virtual GenerateClangDatabaseConfig Nuke.Unreal.Tools.UbtConfigGenerated.GenerateClangDatabaseConfig.OutputFilename ( object val = null )

virtual

Optionally override the output filename for handling multiple targets.

Definition at line 14060 of file UbtConfigGenerated.cs.

Member Data Documentation

_configs

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

private

Definition at line 14099 of file UbtConfigGenerated.cs.

Property Documentation

CliName

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

get

Definition at line 13935 of file UbtConfigGenerated.cs.

Compatibility

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

get

Definition at line 13936 of file UbtConfigGenerated.cs.

Configs

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

getprotected

Definition at line 14100 of file UbtConfigGenerated.cs.

Name

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

get

Definition at line 13934 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