From 891b8f33c160edfdf40efa1b8676d7624d0a13b8 Mon Sep 17 00:00:00 2001 From: Niels Date: Sun, 21 Jun 2015 22:56:03 +0200 Subject: [PATCH] more documentation --- doc/Doxyfile | 2 +- doc/doxyindex.cpp | 9 --------- src/json.hpp | 11 +++++++++-- src/json.hpp.re2c | 11 +++++++++-- 4 files changed, 19 insertions(+), 14 deletions(-) delete mode 100644 doc/doxyindex.cpp diff --git a/doc/Doxyfile b/doc/Doxyfile index 467f0c3e..8c7c9ade 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -101,7 +101,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = ../src/json.hpp doxyindex.cpp +INPUT = ../src/json.hpp INPUT_ENCODING = UTF-8 FILE_PATTERNS = RECURSIVE = NO diff --git a/doc/doxyindex.cpp b/doc/doxyindex.cpp deleted file mode 100644 index 17fe66ed..00000000 --- a/doc/doxyindex.cpp +++ /dev/null @@ -1,9 +0,0 @@ -/*! -@mainpage - -See @ref nlohmann::basic_json - -@copyright Niels Lohmann\n -@include "../../LICENSE.MIT" -*/ - diff --git a/src/json.hpp b/src/json.hpp index 6b17233d..1b3e335f 100644 --- a/src/json.hpp +++ b/src/json.hpp @@ -1,12 +1,19 @@ /*! -@file +@mainpage + +These pages contain the API documentation of JSON for Modern C++, a C++11 +header-only JSON class. + +Class @ref nlohmann::basic_json is a good entry point for the documentation. + @copyright The code is licensed under the MIT License , Copyright (c) 2013-2015 Niels Lohmann. @author Niels Lohmann -@see https://github.com/nlohmann/json +@see https://github.com/nlohmann/json to download the source code */ + #ifndef NLOHMANN_JSON_HPP #define NLOHMANN_JSON_HPP diff --git a/src/json.hpp.re2c b/src/json.hpp.re2c index ab8f1459..7de48dff 100644 --- a/src/json.hpp.re2c +++ b/src/json.hpp.re2c @@ -1,12 +1,19 @@ /*! -@file +@mainpage + +These pages contain the API documentation of JSON for Modern C++, a C++11 +header-only JSON class. + +Class @ref nlohmann::basic_json is a good entry point for the documentation. + @copyright The code is licensed under the MIT License , Copyright (c) 2013-2015 Niels Lohmann. @author Niels Lohmann -@see https://github.com/nlohmann/json +@see https://github.com/nlohmann/json to download the source code */ + #ifndef NLOHMANN_JSON_HPP #define NLOHMANN_JSON_HPP