HyperDbg Documentation
HyperDbg
Download
Source code
Blog
Search…
HyperDbg
Getting Started
Quick Start
FAQ
Build & Install
Attach to HyperDbg
Using HyperDbg
Prerequisites
User-mode Debugging
Kernel-mode Debugging
Commands
Debugging Commands
Meta Commands
Extension Commands
Scripting Language
Tips & Tricks
Considerations
Nested-Virtualization Environments
Misc
Contribution
Style Guide
Coding style
Command style
Doxygen style
Logo & Artworks
Design
Features
Debugger Internals
Script Engine
Links
Twitter
YouTube
Doxygen
Contribution
Powered By
GitBook
Doxygen style
This guide introduces a consistent style for documenting HypedDbg source code using Doxygen
This guide introduces a consistent style for documenting HyperDbg 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:
1
/**
2
* Brief summary.
3
*
4
* Detailed description. More detail.
5
* @see Some reference
6
*
7
* @param <name> Parameter description.
8
* @return Return value description.
9
*/
Copied!
Example:
1
/**
2
* @brief Power function in order to computer address for MSR bitmaps
3
*
4
* @param Base Base for power function
5
* @param Exp Exponent for power function
6
* @return int Returns the result of power function
7
*/
8
int
9
MathPower
(
int
Base
,
int
Exp
)
10
{
11
...
12
}
Copied!
Doxygen Tags
This is the allowed set of Doxygen tags that can be used.
​
@brief
:
Starts a paragraph that serves as a brief description.
​
@details
: Just like
@brief
starts a brief description,
\details
starts the detailed description.
​
@param
: Describes function parameters.
​
@return
: Describes return values.
​
@see
: Describes a cross-reference to classes, functions, methods, variables, files, or URL.
​
@warning
: Starts a paragraph where one or more warning messages may be entered.
Also, don't forget to add your name on top of the file with
@author
tag.
Previous
Command style
Next - Contribution
Logo & Artworks
Last modified
6mo ago
Copy link
Edit on GitHub
Contents
Doxygen Tags