Comment on page
Doxygen style
This guide introduces a consistent style for documenting HypedDbg source code using Doxygen
If you want to create a pull request and contribute in HyperDbg, please follow the Doxygen guides in the source code.
We follow the Javadoc syntax to mark comment blocks.
These have the general form for functions, structures, enums, global variables:
/**
* Brief summary.
*
* Detailed description. More detail.
* @see Some reference
*
* @param <name> Parameter description.
* @return Return value description.
*/
/**
* @brief Power function in order to computer address for MSR bitmaps
*
* @param Base Base for power function
* @param Exp Exponent for power function
* @return int Returns the result of power function
*/
int
MathPower(int Base, int Exp)
{
...
}
This is the allowed set of Doxygen tags that can be used.
Also, don't forget to add your name on top of the file with
@author
tag.Last modified 2yr ago