Add doxygen of classes

boostorg · Jan 30, 2025 · 0d4c9f4 · 0d4c9f4
1 parent f213f27
commit 0d4c9f4
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/doc/Jamfile.v2 b/doc/Jamfile.v2
@@ -69,6 +69,8 @@ doxygen_files =
     weibull_distribution
     xor_combine
     traits
+    splitmix64
+    xoshiro
 ;
 
 path-constant here : . ;

diff --git a/doc/generators.qbk b/doc/generators.qbk
@@ -91,7 +91,7 @@ numbers mean faster random number generation.
   [[__xoshiro512d] [2[sup 512]] [`8*sizeof(uint64_t)`] [144%] [This generator returns doubles instead of uint64_t. It is modified xoshiro512+ from https://prng.di.unimi.it]]
   [[__xoshiro512mm] [2[sup 512]] [`8*sizeof(uint64_t)`] [113%] [xoshiro512** from https://prng.di.unimi.it]]
   [[__xoshiro128pp] [2[sup 128]] [`4*sizeof(uint32_t)`] [133%] [xoshiro128++ from https://prng.di.unimi.it. Returns uint32_t]]
-  [[__xoshiro128d] [2[sup 128]] [`4*sizeof(uint32_t)`] [145%] [This generator returns float instead of uint32_t. It is modified xoshiro128+ from https://prng.di.unimi.it]]
+  [[__xoshiro128f] [2[sup 128]] [`4*sizeof(uint32_t)`] [145%] [This generator returns float instead of uint32_t. It is modified xoshiro128+ from https://prng.di.unimi.it]]
   [[__xoshiro128mm] [2[sup 128]] [`4*sizeof(uint32_t)`] [116%] [xoshiro128** from https://prng.di.unimi.it. Returns uint32_t]]
 
 ]

diff --git a/doc/random.qbk b/doc/random.qbk
@@ -1,7 +1,7 @@
 [library Boost.Random
   [quickbook 1.5]
   [authors [Maurer, Jens]]
-  [copyright 2000-2005 Jens Maurer, 2009-2010 Steven Watanabe]
+  [copyright 2000-2005 Jens Maurer, 2009-2010 Steven Watanabe, 2022-2025 Matt Borland]
   [license
       Distributed under the Boost Software License, Version 1.0.
       (See accompanying file LICENSE_1_0.txt or copy at
@@ -69,6 +69,16 @@
 [def __niederreiter_base2 [classref boost::random::niederreiter_base2 niederreiter_base2]]
 [def __sobol [classref boost::random::sobol sobol]]
 [def __faure [classref boost::random::faure faure]]
+[def __splitmix64 [classref boost::random::splitmix64 splitmix64]]
+[def __xoshiro256pp [classref boost::random::xoshiro256pp xoshiro256pp]]
+[def __xoshiro256d [classref boost::random::xoshiro256d xoshiro256d]]
+[def __xoshiro256mm [classref boost::random::xoshiro256mm xoshiro256mm]]
+[def __xoshiro512pp [classref boost::random::xoshiro512pp xoshiro512pp]]
+[def __xoshiro512d [classref boost::random::xoshiro512d xoshiro512d]]
+[def __xoshiro512mm [classref boost::random::xoshiro512mm xoshiro512mm]]
+[def __xoshiro128pp [classref boost::random::xoshiro128pp xoshiro128pp]]
+[def __xoshiro128f [classref boost::random::xoshiro128f xoshiro128f]]
+[def __xoshiro128mm [classref boost::random::xoshiro128mm xoshiro128mm]]
 
 [def __uniform_smallint [classref boost::random::uniform_smallint uniform_smallint]]
 [def __uniform_int_distribution [classref boost::random::uniform_int_distribution uniform_int_distribution]]