From a213d2d881962bbb2a3b271b58584c2ef3d3c6f0 Mon Sep 17 00:00:00 2001 From: "Philipp A. Hartmann" Date: Sun, 6 Jul 2014 16:39:23 +0200 Subject: [PATCH] Doxygen: fixup main page To avoid the {#mainpage} tag to be rendered on GitHub, explicitly add a `\mainpage` section to `rapidjson.h`, referring to `readme.md`. --- include/rapidjson/rapidjson.h | 4 ++++ readme.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/include/rapidjson/rapidjson.h b/include/rapidjson/rapidjson.h index bd500bc..b6cb2f4 100644 --- a/include/rapidjson/rapidjson.h +++ b/include/rapidjson/rapidjson.h @@ -10,6 +10,10 @@ \todo Complete Doxygen documentation for configure macros. */ +/*! \mainpage + Documentation can be found in \ref readme.md README. +*/ + #include // malloc(), realloc(), free() #include // memcpy() diff --git a/readme.md b/readme.md index 98a51eb..1741d91 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# RapidJSON {#mainpage} +# RapidJSON Copyright (c) 2011-2014 Milo Yip (miloyip@gmail.com)