moved documentation to index markdown file
This commit is contained in:
parent
740239cef8
commit
22127a4b85
5 changed files with 63 additions and 93 deletions
|
@ -101,7 +101,7 @@ WARN_LOGFILE =
|
|||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the input files
|
||||
#---------------------------------------------------------------------------
|
||||
INPUT = ../src/json.hpp
|
||||
INPUT = ../src/json.hpp index.md
|
||||
INPUT_ENCODING = UTF-8
|
||||
FILE_PATTERNS =
|
||||
RECURSIVE = NO
|
||||
|
@ -117,7 +117,7 @@ INPUT_FILTER =
|
|||
FILTER_PATTERNS =
|
||||
FILTER_SOURCE_FILES = NO
|
||||
FILTER_SOURCE_PATTERNS =
|
||||
USE_MDFILE_AS_MAINPAGE =
|
||||
USE_MDFILE_AS_MAINPAGE = index.md
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to source browsing
|
||||
#---------------------------------------------------------------------------
|
||||
|
|
21
doc/index.md
Normal file
21
doc/index.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
# JSON for Modern C++
|
||||
|
||||
These pages contain the API documentation of JSON for Modern C++, a C++11 header-only JSON class.
|
||||
|
||||
- @link nlohmann::basic_json `basic_json` class @endlink
|
||||
- Types
|
||||
- @link nlohmann::basic_json::array_t arrays @endlink
|
||||
- @link nlohmann::basic_json::object_t objects @endlink
|
||||
- @link nlohmann::basic_json::string_t strings @endlink
|
||||
- @link nlohmann::basic_json::boolean_t booleans @endlink
|
||||
- numbers
|
||||
- @link nlohmann::basic_json::number_integer_t signed integers @endlink
|
||||
- @link nlohmann::basic_json::number_unsigned_t unsigned integers @endlink
|
||||
- @link nlohmann::basic_json::number_float_t floating-point @endlink
|
||||
|
||||
@copyright Copyright © 2013-2016 Niels Lohmann. The code is licensed under the [MIT License](http://opensource.org/licenses/MIT).
|
||||
|
||||
@author [Niels Lohmann](http://nlohmann.me)
|
||||
@see https://github.com/nlohmann/json to download the source code
|
||||
|
||||
@version 2.0.0
|
Loading…
Add table
Add a link
Reference in a new issue