Skip to content

Commit 4fad446

Browse files
authored
docs: add IDs to @requirement tags to fix Doxygen autolinking (#5162)
Signed-off-by: Swastik Bose <cpswastik31@gmail.com>
1 parent e0f8cdf commit 4fad446

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

include/nlohmann/detail/iterators/iter_impl.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This class implements a both iterators (iterator and const_iterator) for the
3535
been set (e.g., by a constructor or a copy assignment). If the iterator is
3636
default-constructed, it is *uninitialized* and most methods are undefined.
3737
**The library uses assertions to detect calls on uninitialized iterators.**
38-
@requirement The class satisfies the following concept requirements:
38+
@requirement REQ-JSON-01 The class satisfies the following concept requirements:
3939
-
4040
[BidirectionalIterator](https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator):
4141
The iterator that can be moved can be moved in both directions (i.e.

include/nlohmann/detail/iterators/json_reverse_iterator.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace detail
2929
iterator (to create @ref reverse_iterator) and @ref const_iterator (to
3030
create @ref const_reverse_iterator).
3131
32-
@requirement The class satisfies the following concept requirements:
32+
@requirement REQ-JSON-02 The class satisfies the following concept requirements:
3333
-
3434
[BidirectionalIterator](https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator):
3535
The iterator that can be moved can be moved in both directions (i.e.

single_include/nlohmann/json.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13807,7 +13807,7 @@ This class implements a both iterators (iterator and const_iterator) for the
1380713807
been set (e.g., by a constructor or a copy assignment). If the iterator is
1380813808
default-constructed, it is *uninitialized* and most methods are undefined.
1380913809
**The library uses assertions to detect calls on uninitialized iterators.**
13810-
@requirement The class satisfies the following concept requirements:
13810+
@requirement REQ-JSON-01 The class satisfies the following concept requirements:
1381113811
-
1381213812
[BidirectionalIterator](https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator):
1381313813
The iterator that can be moved can be moved in both directions (i.e.
@@ -14566,7 +14566,7 @@ namespace detail
1456614566
iterator (to create @ref reverse_iterator) and @ref const_iterator (to
1456714567
create @ref const_reverse_iterator).
1456814568

14569-
@requirement The class satisfies the following concept requirements:
14569+
@requirement REQ-JSON-02 The class satisfies the following concept requirements:
1457014570
-
1457114571
[BidirectionalIterator](https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator):
1457214572
The iterator that can be moved can be moved in both directions (i.e.

0 commit comments

Comments
 (0)