gvsafronov/rapidjson
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen: fixup main page

Browse Source 
To avoid the {#mainpage} tag to be rendered on GitHub, explicitly add a
`\mainpage` section to `rapidjson.h`, referring to `readme.md`.
This commit is contained in:
Philipp A. Hartmann 2014-07-06 16:39:23 +02:00
parent b197be2f30
commit a213d2d881
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/rapidjson/rapidjson.h
View File

@ -10,6 +10,10 @@
\todo Complete Doxygen documentation for configure macros. \todo Complete Doxygen documentation for configure macros.
*/ */
/*! \mainpage
Documentation can be found in \ref readme.md README.
*/
#include <cstdlib> // malloc(), realloc(), free() #include <cstdlib> // malloc(), realloc(), free()
#include <cstring> // memcpy() #include <cstring> // memcpy()

2
readme.md
View File

@ -1,4 +1,4 @@
# RapidJSON {#mainpage} # RapidJSON
Copyright (c) 2011-2014 Milo Yip (miloyip@gmail.com) Copyright (c) 2011-2014 Milo Yip (miloyip@gmail.com)