mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
6447011bc3
We build docs in three different places, which is annoying to deal with, and it means we build docs two more times than necessary. Now, docs are built just once in the main Gradle workflow, with warnings promoted to errors, eliminating the need for the separate job in lint-format.yml. The uploaded docs artifact is then unpacked and commited to the GitHub Pages repo like normal.
94 lines
4.1 KiB
Diff
94 lines
4.1 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Gold856 <117957790+Gold856@users.noreply.github.com>
|
|
Date: Tue, 27 May 2025 23:39:02 -0400
|
|
Subject: [PATCH 5/5] Fix Doxygen warnings
|
|
|
|
---
|
|
include/nlohmann/json.hpp | 31 ++++++-------------------------
|
|
1 file changed, 6 insertions(+), 25 deletions(-)
|
|
|
|
diff --git a/include/nlohmann/json.hpp b/include/nlohmann/json.hpp
|
|
index a89e2151e589663ba487a462c3d15cd247ff06cf..a5b4f8b4a118c1f5763ec6ba596a8a2d3d5791eb 100644
|
|
--- a/include/nlohmann/json.hpp
|
|
+++ b/include/nlohmann/json.hpp
|
|
@@ -161,7 +161,7 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
|
|
using serializer = ::nlohmann::detail::serializer<basic_json>;
|
|
|
|
using value_t = detail::value_t;
|
|
- /// JSON Pointer, see @ref nlohmann::json_pointer
|
|
+ /// JSON Pointer, see @ref json_pointer
|
|
using json_pointer = ::nlohmann::json_pointer<StringType>;
|
|
template<typename T, typename SFINAE>
|
|
using json_serializer = JSONSerializer<T, SFINAE>;
|
|
@@ -173,7 +173,7 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
|
|
using initializer_list_t = std::initializer_list<detail::json_ref<basic_json>>;
|
|
|
|
using input_format_t = detail::input_format_t;
|
|
- /// SAX interface type, see @ref nlohmann::json_sax
|
|
+ /// SAX interface type, see nlohmann::json_sax
|
|
using json_sax_t = json_sax<basic_json>;
|
|
|
|
////////////////
|
|
@@ -1606,13 +1606,6 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
|
|
|
|
@throw what @ref json_serializer<ValueType> `from_json()` method throws
|
|
|
|
- @liveexample{The example below shows several conversions from JSON values
|
|
- to other types. There a few things to note: (1) Floating-point numbers can
|
|
- be converted to integers\, (2) A JSON array can be converted to a standard
|
|
- `std::vector<short>`\, (3) A JSON object can be converted to C++
|
|
- associative containers such as `std::unordered_map<std::string\,
|
|
- json>`.,get__ValueType_const}
|
|
-
|
|
@since version 2.1.0
|
|
*/
|
|
template < typename ValueType,
|
|
@@ -1678,7 +1671,7 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
|
|
|
|
@return a copy of *this, converted into @a BasicJsonType
|
|
|
|
- @complexity Depending on the implementation of the called `from_json()`
|
|
+ Complexity: Depending on the implementation of the called `from_json()`
|
|
method.
|
|
|
|
@since version 3.2.0
|
|
@@ -1702,7 +1695,7 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
|
|
|
|
@return a copy of *this
|
|
|
|
- @complexity Constant.
|
|
+ Complexity: Constant.
|
|
|
|
@since version 2.1.0
|
|
*/
|
|
@@ -1786,12 +1779,7 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
|
|
@return pointer to the internally stored JSON value if the requested
|
|
pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
|
|
|
|
- @complexity Constant.
|
|
-
|
|
- @liveexample{The example below shows how pointers to internal values of a
|
|
- JSON value can be requested. Note that no type conversions are made and a
|
|
- `nullptr` is returned if the value and the requested pointer type does not
|
|
- match.,get__PointerType}
|
|
+ Complexity: Constant.
|
|
|
|
@sa see @ref get_ptr() for explicit pointer-member access
|
|
|
|
@@ -1883,14 +1871,7 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
|
|
to the JSON value type (e.g., the JSON value is of type boolean, but a
|
|
string is requested); see example below
|
|
|
|
- @complexity Linear in the size of the JSON value.
|
|
-
|
|
- @liveexample{The example below shows several conversions from JSON values
|
|
- to other types. There a few things to note: (1) Floating-point numbers can
|
|
- be converted to integers\, (2) A JSON array can be converted to a standard
|
|
- `std::vector<short>`\, (3) A JSON object can be converted to C++
|
|
- associative containers such as `std::unordered_map<std::string\,
|
|
- json>`.,operator__ValueType}
|
|
+ Complexity: Linear in the size of the JSON value.
|
|
|
|
@since version 1.0.0
|
|
*/
|