Skip to content

Commit 9c15226

Browse files
committed
Add cross references in examples
1 parent 9b69468 commit 9c15226

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

doc/modules/ROOT/nav.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
* xref:overview.adoc[]
22
* xref:basics.adoc[]
33
* xref:examples.adoc[]
4+
** xref:examples.adoc#examples_construction[Construction]
5+
** xref:examples.adoc#examples_promotion[Type Promotion]
6+
** xref:examples.adoc#examples_charconv[`<charconv>`]
7+
** xref:examples.adoc#examples_rounding_mode[Rounding Mode]
8+
** xref:examples.adoc#examples_generic_programming[Generic Programming]
9+
** xref:examples.adoc#examples_literals_constants[Literals and Constants]
10+
** xref:examples.adoc#examples_bit_conversions[Bit Conversions]
11+
** xref:examples.adoc#examples_finance[Financial Applications]
12+
** xref:examples.adoc#examples_boost_math[Boost.Math Integration]
413
* xref:api_reference.adoc[]
514
** xref:api_reference.adoc#api_ref_types[Types]
615
** xref:api_reference.adoc#api_ref_structs[Structs]

doc/modules/ROOT/pages/examples.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ https://www.boost.org/LICENSE_1_0.txt
1010

1111
All examples can be found in the library `examples/` folder as well.
1212

13+
[#examples_construction]
1314
== Construction from an Integer and Exponent
1415

1516
[source, c++]
@@ -38,6 +39,7 @@ int main()
3839
This is the recommended way of constructing a fractional number as opposed to `decimal32_t a {0.2}`.
3940
The representation is exact with integers whereas you may get surprising or unwanted conversion from binary floating point
4041

42+
[#examples_promotion]
4143
== Promotion
4244

4345
[source, c++]
@@ -61,6 +63,7 @@ int main()
6163
}
6264
----
6365

66+
[#examples_charconv]
6467
== charconv
6568

6669
[source, c++]
@@ -98,7 +101,7 @@ Output:
98101
Returned Value: 0.25
99102
----
100103
101-
104+
[#examples_rounding_mode]
102105
== Rounding Mode
103106
[source, c++]
104107
----
@@ -117,6 +120,7 @@ int main()
117120
}
118121
----
119122
123+
[#examples_generic_programming]
120124
== Generic Programming
121125
[source, c++]
122126
----
@@ -157,6 +161,7 @@ int main()
157161
}
158162
----
159163
164+
[#examples_literals_constants]
160165
== Literals and Constants
161166
[source, c++]
162167
----
@@ -186,6 +191,7 @@ int main()
186191
}
187192
----
188193
194+
[#examples_bit_conversions]
189195
== Bit Conversions
190196
[source, c++]
191197
----
@@ -217,6 +223,7 @@ BID format: 31fc4b40
217223
DPD format: 35f00000
218224
----
219225
226+
[#examples_finance]
220227
== Financial Applications
221228
222229
=== Simple Moving Average
@@ -229,6 +236,7 @@ This serves as a framework for other calculations for securities.
229236
In the examples folder there is a file named `currency_conversion.cpp`.
230237
This example shows how to simply convert currencies based off a given exchange rate.
231238
239+
[#examples_boost_math]
232240
== Boost.Math Integration
233241
234242
=== Bollinger Bands

0 commit comments

Comments
 (0)