From 479a550ba7f70777dbe57c7fd4d9068f8b68b8f1 Mon Sep 17 00:00:00 2001 From: Mark Gillard Date: Thu, 6 May 2021 15:56:36 +0300 Subject: [PATCH] documentation fixes --- docs/poxy.toml | 1 + include/toml++/toml_array.hpp | 3 --- include/toml++/toml_default_formatter.h | 4 ++++ include/toml++/toml_default_formatter.hpp | 3 --- include/toml++/toml_instantiations.hpp | 3 --- include/toml++/toml_json_formatter.h | 6 ++++++ include/toml++/toml_json_formatter.hpp | 3 --- include/toml++/toml_node.hpp | 3 --- include/toml++/toml_parser.hpp | 3 --- include/toml++/toml_table.hpp | 3 --- include/toml++/toml_utf8_streams.hpp | 3 --- toml.hpp | 2 ++ tools/requirements.txt | 2 +- 13 files changed, 14 insertions(+), 25 deletions(-) diff --git a/docs/poxy.toml b/docs/poxy.toml index f155d41..c210bbe 100644 --- a/docs/poxy.toml +++ b/docs/poxy.toml @@ -9,6 +9,7 @@ favicon = 'images/favicon.ico' navbar = [ 'namespaces', 'annotated' ] sources = [ 'pages' ] recursive_sources = [ '../include' ] +source_patterns = [ '*.h', '*.dox' ] strip_paths = [ '../include' ] extra_files = [ 'images/banner_small.png', diff --git a/include/toml++/toml_array.hpp b/include/toml++/toml_array.hpp index 06dd6d9..ef5b7dd 100644 --- a/include/toml++/toml_array.hpp +++ b/include/toml++/toml_array.hpp @@ -2,7 +2,6 @@ //# Copyright (c) Mark Gillard //# See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT -/// \cond #pragma once //# {{ @@ -357,5 +356,3 @@ TOML_NAMESPACE_START } } TOML_NAMESPACE_END; - -/// \endcond diff --git a/include/toml++/toml_default_formatter.h b/include/toml++/toml_default_formatter.h index 53ca7b2..dbe4579 100644 --- a/include/toml++/toml_default_formatter.h +++ b/include/toml++/toml_default_formatter.h @@ -57,6 +57,8 @@ TOML_NAMESPACE_START class TOML_API default_formatter final : impl::formatter { private: + /// \cond + using base = impl::formatter; std::vector key_path; bool pending_table_separator_ = false; @@ -326,6 +328,8 @@ TOML_NAMESPACE_START } } + /// \endcond + public: /// \brief The default flags for a default_formatter. diff --git a/include/toml++/toml_default_formatter.hpp b/include/toml++/toml_default_formatter.hpp index cab82c4..b739425 100644 --- a/include/toml++/toml_default_formatter.hpp +++ b/include/toml++/toml_default_formatter.hpp @@ -2,7 +2,6 @@ //# Copyright (c) Mark Gillard //# See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT -/// \cond #pragma once //# {{ @@ -266,5 +265,3 @@ TOML_IMPL_NAMESPACE_END; #endif // TOML_WINDOWS_COMPAT TOML_POP_WARNINGS; // TOML_DISABLE_SWITCH_WARNINGS, TOML_DISABLE_ARITHMETIC_WARNINGS - -/// \endcond diff --git a/include/toml++/toml_instantiations.hpp b/include/toml++/toml_instantiations.hpp index 18179e9..90fd5d8 100644 --- a/include/toml++/toml_instantiations.hpp +++ b/include/toml++/toml_instantiations.hpp @@ -2,7 +2,6 @@ //# Copyright (c) Mark Gillard //# See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT -/// \cond #pragma once //# {{ @@ -154,5 +153,3 @@ TOML_NAMESPACE_START #endif // TOML_PARSER } TOML_NAMESPACE_END; - -/// \endcond diff --git a/include/toml++/toml_json_formatter.h b/include/toml++/toml_json_formatter.h index dc55c6a..71b35a2 100644 --- a/include/toml++/toml_json_formatter.h +++ b/include/toml++/toml_json_formatter.h @@ -5,6 +5,8 @@ #pragma once #include "toml_formatter.h" +#include "toml_table.h" +#include "toml_array.h" TOML_PUSH_WARNINGS; TOML_DISABLE_SWITCH_WARNINGS; @@ -47,6 +49,8 @@ TOML_NAMESPACE_START class TOML_API json_formatter final : impl::formatter { private: + /// \cond + using base = impl::formatter; void print(const toml::table& tbl); @@ -106,6 +110,8 @@ TOML_NAMESPACE_START } } + /// \endcond + public: /// \brief The default flags for a json_formatter. diff --git a/include/toml++/toml_json_formatter.hpp b/include/toml++/toml_json_formatter.hpp index ecd9dd6..e9ceb8d 100644 --- a/include/toml++/toml_json_formatter.hpp +++ b/include/toml++/toml_json_formatter.hpp @@ -2,7 +2,6 @@ //# Copyright (c) Mark Gillard //# See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT -/// \cond #pragma once //# {{ @@ -62,5 +61,3 @@ TOML_NAMESPACE_START TOML_NAMESPACE_END; TOML_POP_WARNINGS; // TOML_DISABLE_SWITCH_WARNINGS - -/// \endcond diff --git a/include/toml++/toml_node.hpp b/include/toml++/toml_node.hpp index c7b05ee..a7ace84 100644 --- a/include/toml++/toml_node.hpp +++ b/include/toml++/toml_node.hpp @@ -2,7 +2,6 @@ //# Copyright (c) Mark Gillard //# See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT -/// \cond #pragma once //# {{ @@ -101,5 +100,3 @@ TOML_NAMESPACE_START } } TOML_NAMESPACE_END; - -/// \endcond diff --git a/include/toml++/toml_parser.hpp b/include/toml++/toml_parser.hpp index 0646fb9..279e378 100644 --- a/include/toml++/toml_parser.hpp +++ b/include/toml++/toml_parser.hpp @@ -2,7 +2,6 @@ //# Copyright (c) Mark Gillard //# See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT -/// \cond #pragma once //# {{ @@ -3128,5 +3127,3 @@ TOML_NAMESPACE_START TOML_NAMESPACE_END; TOML_POP_WARNINGS; // TOML_DISABLE_SPAM_WARNINGS, TOML_DISABLE_SWITCH_WARNINGS - -/// \endcond diff --git a/include/toml++/toml_table.hpp b/include/toml++/toml_table.hpp index 06a5048..db44133 100644 --- a/include/toml++/toml_table.hpp +++ b/include/toml++/toml_table.hpp @@ -2,7 +2,6 @@ //# Copyright (c) Mark Gillard //# See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT -/// \cond #pragma once //# {{ @@ -354,5 +353,3 @@ TOML_NAMESPACE_START } } TOML_NAMESPACE_END; - -/// \endcond diff --git a/include/toml++/toml_utf8_streams.hpp b/include/toml++/toml_utf8_streams.hpp index c5d01ca..f5dbbf4 100644 --- a/include/toml++/toml_utf8_streams.hpp +++ b/include/toml++/toml_utf8_streams.hpp @@ -2,7 +2,6 @@ //# Copyright (c) Mark Gillard //# See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT -/// \cond #pragma once //# {{ @@ -109,5 +108,3 @@ TOML_IMPL_NAMESPACE_END; #undef TOML_ERROR_CHECK #undef TOML_ERROR - -/// \endcond diff --git a/toml.hpp b/toml.hpp index 3d7e215..c026e3e 100644 --- a/toml.hpp +++ b/toml.hpp @@ -7282,6 +7282,7 @@ TOML_NAMESPACE_START class TOML_API default_formatter final : impl::formatter { private: + using base = impl::formatter; std::vector key_path; bool pending_table_separator_ = false; @@ -7653,6 +7654,7 @@ TOML_NAMESPACE_START class TOML_API json_formatter final : impl::formatter { private: + using base = impl::formatter; void print(const toml::table& tbl); diff --git a/tools/requirements.txt b/tools/requirements.txt index 7870823..06b7060 100644 --- a/tools/requirements.txt +++ b/tools/requirements.txt @@ -1,4 +1,4 @@ misk>=0.4.0 -poxy>=0.1.2 +poxy>=0.2.0 pyyaml python-dateutil