Profiles different unity sizes and prints out the different size and its timings. More...

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

Public Member Functions
virtual IWYUConfig	Write (bool? val=null)
	Will check out files from p4 and write to disk.

virtual IWYUConfig	UpdateOnlyPrivate (bool? val=null)
	Update only includes in cpp files and don't touch headers.

virtual IWYUConfig	ModuleToUpdate (object val=null)
	Which module to run IWYU on. Will also include all modules depending on this module.

virtual IWYUConfig	PathToUpdate (object val=null)
	Which directory to run IWYU on. Will search for modules that has module directory matching this string If no module is found in -PathToUpdate it handles this for individual files instead. Note this can be combined with -ModuleToUpdate to double filter PathToUpdate supports multiple paths using semi colon separation.

virtual IWYUConfig	PathToUpdateFile (object val=null)
	Same as PathToUpdate but provide the list of paths in a text file instead. Add all the desired paths on a separate line.

virtual IWYUConfig	UpdateDependents (bool? val=null)
	Also update modules that are depending on the module we are updating.

virtual IWYUConfig	NoP4 (bool? val=null)
	Will check out files from p4 and write to disk.

virtual IWYUConfig	NoTransitiveIncludes (bool? val=null)
	Allow files to not add includes if they are transitively included by other includes.

virtual IWYUConfig	NoCompile (bool? val=null)
	Will skip compiling before updating. Handle with care, this is dangerous since files might not match .iwyu files.

virtual IWYUConfig	IgnoreUpToDateCheck (bool? val=null)
	Will ignore update check that .iwyu is newer than source files.

virtual IWYUConfig	DeprecateTag (object val=null)
	If set, this will keep removed includes in #if/#endif scope at the end of updated file. Applied to non-private headers that are part of the Engine folder.

virtual IWYUConfig	NoTransitive (bool? val=null)
	Allow files to not add includes if they are transitively included by other includes.

virtual IWYUConfig	RemoveRedundant (bool? val=null)
	Will remove headers that are needed but redundant because they are included through other needed includes.

virtual IWYUConfig	Compare (bool? val=null)
	Compare current include structure with how it would look like if iwyu was applied on all files.

virtual IWYUConfig	WriteToc (bool? val=null)
	For Development only - Will write a toc referencing all .iwyu files. Toc can be used by -ReadToc.

virtual IWYUConfig	ReadToc (bool? val=null)
	For Development only - Will read a toc to find all .iwyu files instead of building the code.

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

Profiles different unity sizes and prints out the different size and its timings.

Definition at line 18423 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ Compare()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.Compare ( bool? val = null )

virtual

Compare current include structure with how it would look like if iwyu was applied on all files.

Definition at line 18710 of file UbtConfigGenerated.cs.

◆ DeprecateTag()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.DeprecateTag ( object val = null )

virtual

If set, this will keep removed includes in #if/#endif scope at the end of updated file. Applied to non-private headers that are part of the Engine folder.

Definition at line 18647 of file UbtConfigGenerated.cs.

◆ IgnoreUpToDateCheck()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.IgnoreUpToDateCheck ( bool? val = null )

virtual

Will ignore update check that .iwyu is newer than source files.

Definition at line 18625 of file UbtConfigGenerated.cs.

◆ ModuleToUpdate()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.ModuleToUpdate ( object val = null )

virtual

Which module to run IWYU on. Will also include all modules depending on this module.

Definition at line 18474 of file UbtConfigGenerated.cs.

◆ NoCompile()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.NoCompile ( bool? val = null )

virtual

Will skip compiling before updating. Handle with care, this is dangerous since files might not match .iwyu files.

Definition at line 18604 of file UbtConfigGenerated.cs.

◆ NoP4()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.NoP4 ( bool? val = null )

virtual

Will check out files from p4 and write to disk.

Definition at line 18562 of file UbtConfigGenerated.cs.

◆ NoTransitive()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.NoTransitive ( bool? val = null )

virtual

Allow files to not add includes if they are transitively included by other includes.

Definition at line 18668 of file UbtConfigGenerated.cs.

◆ NoTransitiveIncludes()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.NoTransitiveIncludes ( bool? val = null )

virtual

Allow files to not add includes if they are transitively included by other includes.

Definition at line 18583 of file UbtConfigGenerated.cs.

◆ PathToUpdate()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.PathToUpdate ( object val = null )

virtual

Which directory to run IWYU on. Will search for modules that has module directory matching this string If no module is found in -PathToUpdate it handles this for individual files instead. Note this can be combined with -ModuleToUpdate to double filter PathToUpdate supports multiple paths using semi colon separation.

Definition at line 18498 of file UbtConfigGenerated.cs.

◆ PathToUpdateFile()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.PathToUpdateFile ( object val = null )

virtual

Same as PathToUpdate but provide the list of paths in a text file instead. Add all the desired paths on a separate line.

Definition at line 18520 of file UbtConfigGenerated.cs.

◆ ReadToc()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.ReadToc ( bool? val = null )

virtual

For Development only - Will read a toc to find all .iwyu files instead of building the code.

Definition at line 18752 of file UbtConfigGenerated.cs.

◆ RemoveRedundant()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.RemoveRedundant ( bool? val = null )

virtual

Will remove headers that are needed but redundant because they are included through other needed includes.

Definition at line 18689 of file UbtConfigGenerated.cs.

◆ UpdateDependents()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.UpdateDependents ( bool? val = null )

virtual

Also update modules that are depending on the module we are updating.

Definition at line 18541 of file UbtConfigGenerated.cs.

◆ UpdateOnlyPrivate()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.UpdateOnlyPrivate ( bool? val = null )

virtual

Update only includes in cpp files and don't touch headers.

Definition at line 18453 of file UbtConfigGenerated.cs.

◆ Write()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.Write ( bool? val = null )

virtual

Will check out files from p4 and write to disk.

Definition at line 18432 of file UbtConfigGenerated.cs.

◆ WriteToc()

virtual IWYUConfig Nuke.Unreal.Tools.UbtConfigGenerated.IWYUConfig.WriteToc ( bool? val = null )

virtual

For Development only - Will write a toc referencing all .iwyu files. Toc can be used by -ReadToc.

Definition at line 18731 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 18770 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 18426 of file UbtConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 18427 of file UbtConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 18771 of file UbtConfigGenerated.cs.

◆ Name

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

get

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

Detailed Description

Member Function Documentation

◆ Compare()

◆ DeprecateTag()

◆ IgnoreUpToDateCheck()

◆ ModuleToUpdate()

◆ NoCompile()

◆ NoP4()

◆ NoTransitive()

◆ NoTransitiveIncludes()

◆ PathToUpdate()

◆ PathToUpdateFile()

◆ ReadToc()

◆ RemoveRedundant()

◆ UpdateDependents()

◆ UpdateOnlyPrivate()

◆ Write()

◆ WriteToc()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name