deavmi/dlog
deavmi
/
dlog
mirror of https://github.com/deavmi/dlog.git
1
0
Fork 0
Code Issues Releases Activity

Context 

- Added documentation headers for `CompilationInfo`
This commit is contained in:
Tristan B. Velloza Kildaire 2023-03-02 11:26:41 +02:00
parent 77448e3245
commit 484b9f949b
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
source/dlog/context.d
View File

@ -57,6 +57,18 @@ public struct CompilationInfo
public string functionName; public string functionName;
public string prettyFunctionName; public string prettyFunctionName;
/**
* Constructs the compilation information with the provided
* parameters
*
* Params:
* __FILE_FULL_PATH__ = compile time usage file
* __FILE__ = compile time usage file (relative)
* __LINE__ = compile time usage line number
* __MODULE__ = compile time usage module
* __FUNCTION__ = compile time usage function
* __PRETTY_FUNCTION__ = compile time usage function (pretty)
*/
this(string fullFilePath, string file, ulong line, string moduleName, string functionName, string prettyFunctionName) this(string fullFilePath, string file, ulong line, string moduleName, string functionName, string prettyFunctionName)
{ {
this.fullFilePath = fullFilePath; this.fullFilePath = fullFilePath;
@ -67,10 +79,13 @@ public struct CompilationInfo
this.prettyFunctionName = prettyFunctionName; this.prettyFunctionName = prettyFunctionName;
} }
/**
* Flattens the known compile-time information into a string array
*
* Returns: a string[]
*/
public string[] toArray() public string[] toArray()
{ {
return [fullFilePath, file, to!(string)(line), moduleName, functionName, prettyFunctionName]; return [fullFilePath, file, to!(string)(line), moduleName, functionName, prettyFunctionName];
} }
}
}