yyc12345/YYCCommonplace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: update documentation in code

Browse Source
This commit is contained in:
yyc12345
2024-07-25 18:15:39 +08:00
parent 31a7cb5675
commit 7f373ed354
6 changed files with 107 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/ExceptionHelper.hpp
View File

@ -6,10 +6,7 @@
* @brief Windows specific unhandled exception processor.
* @details
* This namespace is Windows specific. On other platforms, the whole namespace is unavailable.
*
* This namespace allow user register unhandled exception handler on Windows
* to output error log into \c stderr and log file, and generate coredump if possible.
* This is useful for bug tracing on Windows, especially most Windows user are naive and don't know how to report bug.
* For how to utilize this namespace, please see \ref exception_helper.
*
*/
namespace YYCC::ExceptionHelper {
@ -20,9 +17,9 @@ namespace YYCC::ExceptionHelper {
* This function will set an internal function as unhandled exception handler on Windows.
*
* When unhandled exception raised,
* That internal function will output error stacktrace in standard output
* and log file (located in temp folder), and also generate a dump file
* in temp folder (for convenient debugging of developer when reporting bugs) if it can.
* That internal function will output error stacktrace in standard output,
* and generate log file and dump file in \c \%APPDATA\%/CrashDumps folder if it is possible.
* (for convenient debugging of developer when reporting bugs.)
*
* This function usually is called at the start of program.
*/
@ -33,7 +30,7 @@ namespace YYCC::ExceptionHelper {
* The reverse operation of Register().
*
* This function and Register() should always be used as a pair.
* You must call this function if you have called Register() before.
* You must call this function to release reources if you have called Register().
*
* This function usually is called at the end of program.
*/