Skip to content

Commit 3c80c09

Browse files
committed
documentation fixes
1 parent 10ece22 commit 3c80c09

File tree

5 files changed

+18
-15
lines changed

5 files changed

+18
-15
lines changed

CHANGELOG.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ include::doc/pages/definitions.adoc[]
77

88
== Boost 1.89.0
99

10+
.Documentation
11+
* New documentation style. New reference documentation structure.
12+
1013
.API Changes
1114
* {issue}1050[#1050] Optionals that are ranges are categorised as optionals.
1215
* {issue}1086[#1086] Described class support is enabled for types with bases.

README.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ifdef::env-github[]
88
:source-highlighter: rouge
99
:source-language: c++
1010

11-
[link=https://www.boost.org/doc/libs/release/libs/json]
11+
[link=https://www.boost.org/doc/libs/latest/libs/json]
1212
image:https://raw.githubusercontent.com/CPPAlliance/json/master/doc/images/repo-logo-3.png[Boost.JSON]
1313

1414
[cols=3]
@@ -127,11 +127,11 @@ endif::[]
127127
128128
* Requires only {cpp}11
129129
* Link to a built static or dynamic Boost library (build instructions can be
130-
found https://www.boost.org/doc/libs/release/more/getting_started/index.html[here]),
130+
found https://www.boost.org/doc/libs/latest/more/getting_started/index.html[here]),
131131
or use header-only (see below)
132132
* Additional link to Boost.Container may be required
133133
(as described in its
134-
https://www.boost.org/doc/libs/release/doc/html/container.html#container.intro.introduction_building_container[documentation])
134+
https://www.boost.org/doc/libs/latest/doc/html/container.html#container.intro.introduction_building_container[documentation])
135135
* Supports `-fno-exceptions`, detected automatically (but read
136136
<<Disabling Exceptions,the relevant section>> on this page).
137137
@@ -161,7 +161,7 @@ completely you can define `BOOST_ALL_NO_LIB` instead.
161161
==== Disabling Exceptions
162162
In order to support building with exceptions disabled this library uses another
163163
Boost library,
164-
https://www.boost.org/doc/libs/release/libs/throw_exception[Boost.ThrowException].
164+
https://www.boost.org/doc/libs/latest/libs/throw_exception[Boost.ThrowException].
165165
This allows to automatically discover whether exception support is available.
166166
On the other hand, as explained in Boost.ThrowException's documentation, if
167167
exceptions are disabled, the users need to provide their own implementation for
@@ -193,7 +193,7 @@ definitions:
193193

194194
==== Endianness
195195
Boost.JSON uses
196-
https://www.boost.org/doc/libs/release/libs/endian/doc/html/endian.html[Boost.Endian]
196+
https://www.boost.org/doc/libs/latest/libs/endian/doc/html/endian.html[Boost.Endian]
197197
in order to support both little endian and big endian platforms.
198198

199199
==== Supported Compilers

doc/pages/definitions.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
77
Official repository: https://github.com/boostorg/json
88
////
99

10-
:ref_memory_resource: pass:q[https://boost.org/doc/libs/release/doc/html/doxygen/boost_container_header_reference/classboost_1_1container_1_1pmr_1_1memory__resource.html[`memory_resource`]]
11-
:ref_polymorphic_allocator: pass:q[https://boost.org/doc/libs/release/doc/html/doxygen/boost_container_header_reference/classboost_1_1container_1_1pmr_1_1polymorphic__allocator.html[`polymorphic_allocator`]]
12-
:ref_error_category: pass:q[https://boost.org/doc/libs/release/libs/system/doc/html/system.html#ref_error_category[`error_category`]]
13-
:ref_error_code: pass:q[https://boost.org/doc/libs/release/libs/system/doc/html/system.html#ref_error_code[`error_code`]]
14-
:ref_error_condition: pass:q[https://boost.org/doc/libs/release/libs/system/doc/html/system.html#ref_error_condition[`error_condition`]]
15-
:ref_result: pass:q[https://boost.org/doc/libs/release/libs/system/doc/html/system.html#ref_resultt_e[`result`]]
16-
:ref_system_error: pass:q[https://boost.org/doc/libs/release/libs/system/doc/html/system.html#ref_system_error[`system_error`]]
10+
:ref_memory_resource: pass:q[https://boost.org/doc/libs/latest/doc/html/doxygen/boost_container_header_reference/classboost_1_1container_1_1pmr_1_1memory__resource.html[`memory_resource`]]
11+
:ref_polymorphic_allocator: pass:q[https://boost.org/doc/libs/latest/doc/html/doxygen/boost_container_header_reference/classboost_1_1container_1_1pmr_1_1polymorphic__allocator.html[`polymorphic_allocator`]]
12+
:ref_error_category: pass:q[https://boost.org/doc/libs/latest/libs/system/doc/html/system.html#ref_error_category[`error_category`]]
13+
:ref_error_code: pass:q[https://boost.org/doc/libs/latest/libs/system/doc/html/system.html#ref_error_code[`error_code`]]
14+
:ref_error_condition: pass:q[https://boost.org/doc/libs/latest/libs/system/doc/html/system.html#ref_error_condition[`error_condition`]]
15+
:ref_result: pass:q[https://boost.org/doc/libs/latest/libs/system/doc/html/system.html#ref_resultt_e[`result`]]
16+
:ref_system_error: pass:q[https://boost.org/doc/libs/latest/libs/system/doc/html/system.html#ref_system_error[`system_error`]]
1717

1818
:req_Allocator: pass:q[https://en.cppreference.com/w/cpp/named_req/Allocator[__Allocator__]]
1919
:req_CopyAssignable: pass:q[https://en.cppreference.com/w/cpp/named_req/CopyAssignable[__CopyAssignable__]]

doc/pages/dom/value.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ include::../../../test/snippets.cpp[tag=snippet_value_4,indent=0]
7878
----
7979

8080
The following table shows all of the ways to determine and access the contents
81-
of a `!value!`:
81+
of a <<ref_value>>:
8282

8383
.<<ref_value>> Accessors
8484
[%autowidth,cols=8]

include/boost/json/conversion.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ struct is_null_like
322322
non-public data members to enable this conversion implementation. Note that
323323
non-public bases are not supported regardless.
324324
325-
@see [Boost.Describe](https://www.boost.org/doc/libs/develop/libs/describe/doc/html/describe.html).
325+
@see [Boost.Describe](https://www.boost.org/doc/libs/latest/libs/describe/doc/html/describe.html).
326326
*/
327327
template<class T>
328328
struct is_described_class;
@@ -353,7 +353,7 @@ struct is_described_class;
353353
} // namespace json
354354
@endcode
355355
356-
@see [Boost.Describe](https://www.boost.org/doc/libs/develop/libs/describe/doc/html/describe.html).
356+
@see [Boost.Describe](https://www.boost.org/doc/libs/latest/libs/describe/doc/html/describe.html).
357357
*/
358358
template<class T>
359359
struct is_described_enum;

0 commit comments

Comments
 (0)