From e324936b5652012d8dc72cbc9ce75a5b35c3acb9 Mon Sep 17 00:00:00 2001 From: Niels Lohmann Date: Sun, 7 Nov 2021 20:17:01 +0100 Subject: [PATCH] :memo: document documentation generation --- doc/README.md | 20 ++++++++++++++++++++ include/nlohmann/json.hpp | 15 +++++++++++---- single_include/nlohmann/json.hpp | 15 +++++++++++---- 3 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 000000000..ec5c25d49 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,20 @@ +# Documentation + +## Generate documentation + +Note on documentation: The source files contain links to the online documentation at https://json.nlohmann.me. This URL +contains the most recent documentation and should also be applicable to previous versions; documentation for deprecated +functions is not removed, but marked deprecated. + +If you want to see the documentation for a specific tag or commit hash, you can generate it as follows (here for tag +`v3.10.2`): + +```shell +git clone https://github.com/nlohmann/json.git +cd json +git checkout v3.10.2 +make install_venv serve -C doc/mkdocs +``` + +Open URL in your browser. Replace from any URL from the source code `https://json.nlohmann.me` +with `http://127.0.0.1:8000` to see the documentation for your tag or commit hash. diff --git a/include/nlohmann/json.hpp b/include/nlohmann/json.hpp index 3f327c568..2a96031ea 100644 --- a/include/nlohmann/json.hpp +++ b/include/nlohmann/json.hpp @@ -27,6 +27,15 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/****************************************************************************\ + * Note on documentation: The source files contain links to the online * + * documentation of the public API at https://json.nlohmann.me. This URL * + * contains the most recent documentation and should also be applicable to * + * previous versions; documentation for deprecated functions is not * + * removed, but marked deprecated. See "Generate documentation" section in * + * file doc/README.md. * +\****************************************************************************/ + #ifndef INCLUDE_NLOHMANN_JSON_HPP_ #define INCLUDE_NLOHMANN_JSON_HPP_ @@ -4689,11 +4698,9 @@ struct hash } }; -/// specialization for std::less -/// @note: do not remove the space after '<', -/// see https://github.com/nlohmann/json/pull/679 +// specialization for std::less template<> -struct less< ::nlohmann::detail::value_t> +struct less< ::nlohmann::detail::value_t> // do not remove the space after '<', see https://github.com/nlohmann/json/pull/679 { /*! @brief compare two value_t enum values diff --git a/single_include/nlohmann/json.hpp b/single_include/nlohmann/json.hpp index 63fdd6064..8c962dc9c 100644 --- a/single_include/nlohmann/json.hpp +++ b/single_include/nlohmann/json.hpp @@ -27,6 +27,15 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/****************************************************************************\ + * Note on documentation: The source files contain links to the online * + * documentation of the public API at https://json.nlohmann.me. This URL * + * contains the most recent documentation and should also be applicable to * + * previous versions; documentation for deprecated functions is not * + * removed, but marked deprecated. See "Generate documentation" section in * + * file doc/README.md. * +\****************************************************************************/ + #ifndef INCLUDE_NLOHMANN_JSON_HPP_ #define INCLUDE_NLOHMANN_JSON_HPP_ @@ -21720,11 +21729,9 @@ struct hash } }; -/// specialization for std::less -/// @note: do not remove the space after '<', -/// see https://github.com/nlohmann/json/pull/679 +// specialization for std::less template<> -struct less< ::nlohmann::detail::value_t> +struct less< ::nlohmann::detail::value_t> // do not remove the space after '<', see https://github.com/nlohmann/json/pull/679 { /*! @brief compare two value_t enum values