Doxygen: Amend minor issues (#2593)
Corrects a few issues with regards to Doxygen documentation, for example: - Incorrect parameter referencing. - Missing @param tags. - Typos in @param tags. and a few minor other issues.
This commit is contained in:
parent
b250ce21b9
commit
0cb52ee74a
18 changed files with 31 additions and 23 deletions
|
@ -18,7 +18,8 @@ public:
|
|||
|
||||
/**
|
||||
* Produce debug information based on the given shader and input vertex
|
||||
* @param input Input vertex into the shader
|
||||
* @param setup Shader engine state
|
||||
* @param input Input vertex into the shader
|
||||
* @param config Configuration object for the shader pipeline
|
||||
* @return Debug information for this shader with regards to the given vertex
|
||||
*/
|
||||
|
|
|
@ -93,7 +93,8 @@ private:
|
|||
|
||||
/**
|
||||
* Assertion evaluated at compile-time, but only triggered if executed at runtime.
|
||||
* @param msg Message to be logged if the assertion fails.
|
||||
* @param condition Condition to be evaluated.
|
||||
* @param msg Message to be logged if the assertion fails.
|
||||
*/
|
||||
void Compile_Assert(bool condition, const char* msg);
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue