From c3fcdff0da2fb9e549258a727e99053435c655d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Tue, 25 Oct 2022 21:09:54 +0200 Subject: [PATCH 01/17] Bootstrap ext/random docs with docgen --- appendices/extensions.xml | 4 +- appendices/migration70/new-features.xml | 2 +- appendices/migration70/new-functions.xml | 2 +- reference/csprng/book.xml | 48 -------- reference/math/versions.xml | 7 -- reference/random/book.developer.xml | 72 +++++++++++ .../{csprng/constants.xml => random/book.xml} | 21 +++- reference/random/constants.xml | 49 ++++++++ .../versions.xml => random/examples.xml} | 27 ++-- .../{math => random}/functions/getrandmax.xml | 0 .../{math => random}/functions/lcg-value.xml | 0 .../functions/mt-getrandmax.xml | 0 .../{math => random}/functions/mt-rand.xml | 0 .../{math => random}/functions/mt-srand.xml | 0 reference/{math => random}/functions/rand.xml | 0 .../functions/random-bytes.xml | 0 .../functions/random-int.xml | 0 .../{math => random}/functions/srand.xml | 0 .../random/random.brokenrandomengineerror.xml | 79 ++++++++++++ reference/random/random.cryptosafeengine.xml | 67 ++++++++++ reference/random/random.engine.mt19937.xml | 67 ++++++++++ .../random.engine.pcgoneseq128xslrr64.xml | 67 ++++++++++ reference/random/random.engine.secure.xml | 67 ++++++++++ reference/random/random.engine.xml | 63 ++++++++++ .../random.engine.xoshiro256starstar.xml | 67 ++++++++++ reference/random/random.randomerror.xml | 79 ++++++++++++ reference/random/random.randomexception.xml | 79 ++++++++++++ reference/random/random.randomizer.xml | 85 +++++++++++++ reference/random/random/engine/generate.xml | 77 ++++++++++++ .../random/engine/mt19937/construct.xml | 100 +++++++++++++++ .../random/engine/mt19937/debuginfo.xml | 77 ++++++++++++ .../random/random/engine/mt19937/generate.xml | 77 ++++++++++++ .../random/engine/mt19937/serialize.xml | 77 ++++++++++++ .../random/engine/mt19937/unserialize.xml | 86 +++++++++++++ .../engine/pcgoneseq128xslrr64/construct.xml | 91 ++++++++++++++ .../engine/pcgoneseq128xslrr64/debuginfo.xml | 77 ++++++++++++ .../engine/pcgoneseq128xslrr64/generate.xml | 77 ++++++++++++ .../engine/pcgoneseq128xslrr64/jump.xml | 86 +++++++++++++ .../engine/pcgoneseq128xslrr64/serialize.xml | 77 ++++++++++++ .../pcgoneseq128xslrr64/unserialize.xml | 86 +++++++++++++ .../random/random/engine/secure/generate.xml | 77 ++++++++++++ .../engine/xoshiro256starstar/construct.xml | 91 ++++++++++++++ .../engine/xoshiro256starstar/debuginfo.xml | 77 ++++++++++++ .../engine/xoshiro256starstar/generate.xml | 77 ++++++++++++ .../random/engine/xoshiro256starstar/jump.xml | 77 ++++++++++++ .../engine/xoshiro256starstar/jumplong.xml | 77 ++++++++++++ .../engine/xoshiro256starstar/serialize.xml | 77 ++++++++++++ .../engine/xoshiro256starstar/unserialize.xml | 86 +++++++++++++ .../random/random/randomizer/construct.xml | 91 ++++++++++++++ .../random/random/randomizer/getbytes.xml | 86 +++++++++++++ reference/random/random/randomizer/getint.xml | 95 +++++++++++++++ .../random/random/randomizer/nextint.xml | 77 ++++++++++++ .../random/randomizer/pickarraykeys.xml | 95 +++++++++++++++ .../random/random/randomizer/serialize.xml | 77 ++++++++++++ .../random/random/randomizer/shufflearray.xml | 86 +++++++++++++ .../random/random/randomizer/shufflebytes.xml | 86 +++++++++++++ .../random/random/randomizer/unserialize.xml | 86 +++++++++++++ reference/{csprng => random}/reference.xml | 10 +- reference/{csprng => random}/setup.xml | 13 +- reference/random/versions.xml | 115 ++++++++++++++++++ 60 files changed, 3408 insertions(+), 88 deletions(-) delete mode 100644 reference/csprng/book.xml create mode 100644 reference/random/book.developer.xml rename reference/{csprng/constants.xml => random/book.xml} (56%) create mode 100644 reference/random/constants.xml rename reference/{csprng/versions.xml => random/examples.xml} (58%) rename reference/{math => random}/functions/getrandmax.xml (100%) rename reference/{math => random}/functions/lcg-value.xml (100%) rename reference/{math => random}/functions/mt-getrandmax.xml (100%) rename reference/{math => random}/functions/mt-rand.xml (100%) rename reference/{math => random}/functions/mt-srand.xml (100%) rename reference/{math => random}/functions/rand.xml (100%) rename reference/{csprng => random}/functions/random-bytes.xml (100%) rename reference/{csprng => random}/functions/random-int.xml (100%) rename reference/{math => random}/functions/srand.xml (100%) create mode 100644 reference/random/random.brokenrandomengineerror.xml create mode 100644 reference/random/random.cryptosafeengine.xml create mode 100644 reference/random/random.engine.mt19937.xml create mode 100644 reference/random/random.engine.pcgoneseq128xslrr64.xml create mode 100644 reference/random/random.engine.secure.xml create mode 100644 reference/random/random.engine.xml create mode 100644 reference/random/random.engine.xoshiro256starstar.xml create mode 100644 reference/random/random.randomerror.xml create mode 100644 reference/random/random.randomexception.xml create mode 100644 reference/random/random.randomizer.xml create mode 100644 reference/random/random/engine/generate.xml create mode 100644 reference/random/random/engine/mt19937/construct.xml create mode 100644 reference/random/random/engine/mt19937/debuginfo.xml create mode 100644 reference/random/random/engine/mt19937/generate.xml create mode 100644 reference/random/random/engine/mt19937/serialize.xml create mode 100644 reference/random/random/engine/mt19937/unserialize.xml create mode 100644 reference/random/random/engine/pcgoneseq128xslrr64/construct.xml create mode 100644 reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml create mode 100644 reference/random/random/engine/pcgoneseq128xslrr64/generate.xml create mode 100644 reference/random/random/engine/pcgoneseq128xslrr64/jump.xml create mode 100644 reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml create mode 100644 reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml create mode 100644 reference/random/random/engine/secure/generate.xml create mode 100644 reference/random/random/engine/xoshiro256starstar/construct.xml create mode 100644 reference/random/random/engine/xoshiro256starstar/debuginfo.xml create mode 100644 reference/random/random/engine/xoshiro256starstar/generate.xml create mode 100644 reference/random/random/engine/xoshiro256starstar/jump.xml create mode 100644 reference/random/random/engine/xoshiro256starstar/jumplong.xml create mode 100644 reference/random/random/engine/xoshiro256starstar/serialize.xml create mode 100644 reference/random/random/engine/xoshiro256starstar/unserialize.xml create mode 100644 reference/random/random/randomizer/construct.xml create mode 100644 reference/random/random/randomizer/getbytes.xml create mode 100644 reference/random/random/randomizer/getint.xml create mode 100644 reference/random/random/randomizer/nextint.xml create mode 100644 reference/random/random/randomizer/pickarraykeys.xml create mode 100644 reference/random/random/randomizer/serialize.xml create mode 100644 reference/random/random/randomizer/shufflearray.xml create mode 100644 reference/random/random/randomizer/shufflebytes.xml create mode 100644 reference/random/random/randomizer/unserialize.xml rename reference/{csprng => random}/reference.xml (73%) rename reference/{csprng => random}/setup.xml (72%) create mode 100644 reference/random/versions.xml diff --git a/appendices/extensions.xml b/appendices/extensions.xml index 86330c6e7be2..9488dc6ebba9 100644 --- a/appendices/extensions.xml +++ b/appendices/extensions.xml @@ -21,7 +21,6 @@ - @@ -121,6 +120,7 @@ + @@ -202,7 +202,6 @@ - @@ -256,6 +255,7 @@ + diff --git a/appendices/migration70/new-features.xml b/appendices/migration70/new-features.xml index 7f05505b58a8..f2c1c24da7f4 100644 --- a/appendices/migration70/new-features.xml +++ b/appendices/migration70/new-features.xml @@ -640,7 +640,7 @@ session_start([ - <link linkend="book.csprng">CSPRNG</link> Functions + CSPRNG Functions Two new functions have been added to generate cryptographically secure diff --git a/appendices/migration70/new-functions.xml b/appendices/migration70/new-functions.xml index e3fe3af62e78..dda54d14322f 100644 --- a/appendices/migration70/new-functions.xml +++ b/appendices/migration70/new-functions.xml @@ -17,7 +17,7 @@ - <link linkend="book.csprng">CSPRNG</link> + CSPRNG diff --git a/reference/csprng/book.xml b/reference/csprng/book.xml deleted file mode 100644 index 2f00ffbdc341..000000000000 --- a/reference/csprng/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - CSPRNG - - - &reftitle.intro; - - The cryptographically secure - pseudo-random number generator (CSPRNG) API provides an easy and reliable way to generate crypto-strong random - integers and bytes for use within cryptographic contexts. - - - &version.exists.asof;7.0.0 but there is also a - userland implementation - for PHP >= 5.2.0. - - - - &reference.csprng.setup; - &reference.csprng.constants; - &reference.csprng.reference; - - - - - diff --git a/reference/math/versions.xml b/reference/math/versions.xml index 34bd2fb1c69b..0429d661a3aa 100644 --- a/reference/math/versions.xml +++ b/reference/math/versions.xml @@ -26,31 +26,24 @@ - - - - - - - diff --git a/reference/random/book.developer.xml b/reference/random/book.developer.xml new file mode 100644 index 000000000000..9d47536facc5 --- /dev/null +++ b/reference/random/book.developer.xml @@ -0,0 +1,72 @@ + + + + + + +%xhtml-lat1; +%xhtml-symbol; +%xhtml-special; +%isopub; + + + + + + +%language-defs.default; +%extensions.default; +%language-snippets.default; + + + + + + + + + +%global.entities; +%file.entities; +%frontpage.entities; +]> + + + Random + Random + + + &reftitle.intro; + + + + + + &reference.random.setup; + &reference.random.constants; + &reference.random.examples; + &reference.random.reference; + + + diff --git a/reference/csprng/constants.xml b/reference/random/book.xml similarity index 56% rename from reference/csprng/constants.xml rename to reference/random/book.xml index 17955d40211d..e8e5bb245d97 100644 --- a/reference/csprng/constants.xml +++ b/reference/random/book.xml @@ -1,11 +1,21 @@ - + + Random + Random - - &reftitle.constants; - &no.constants; - + + &reftitle.intro; + + + + + &reference.random.setup; + &reference.random.constants; + &reference.random.examples; + &reference.random.reference; + + - diff --git a/reference/random/constants.xml b/reference/random/constants.xml new file mode 100644 index 000000000000..42ec92c26f5c --- /dev/null +++ b/reference/random/constants.xml @@ -0,0 +1,49 @@ + + + &reftitle.constants; + &extension.constants; + + + + + MT_RAND_MT19937 + (integer) + + + + + + + + + MT_RAND_PHP + (integer) + + + + + + + + + + diff --git a/reference/csprng/versions.xml b/reference/random/examples.xml similarity index 58% rename from reference/csprng/versions.xml rename to reference/random/examples.xml index 764cdf851ab0..3341a7146afa 100644 --- a/reference/csprng/versions.xml +++ b/reference/random/examples.xml @@ -1,14 +1,25 @@ - - + + &reftitle.examples; + + Random Example + + - - - +/* ... */ +?> +]]> + + &example.outputs.similar; + + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\BrokenRandomEngineError + + + + + Random\BrokenRandomEngineError + + + + extends + Random\RandomError + + + + Throwable + + + + &InheritedProperties; + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + + + &reference.random.entities.random-brokenrandomengineerror; + + + diff --git a/reference/random/random.cryptosafeengine.xml b/reference/random/random.cryptosafeengine.xml new file mode 100644 index 000000000000..a7f87ac057e5 --- /dev/null +++ b/reference/random/random.cryptosafeengine.xml @@ -0,0 +1,67 @@ + + + The Random\CryptoSafeEngine interface + Random\CryptoSafeEngine + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\CryptoSafeEngine + + + + + Random\CryptoSafeEngine + + + + Random\Engine + + + + + &Methods; + + + + +
+ +
+ + &reference.random.entities.random-cryptosafeengine; + +
+ diff --git a/reference/random/random.engine.mt19937.xml b/reference/random/random.engine.mt19937.xml new file mode 100644 index 000000000000..26870507a45f --- /dev/null +++ b/reference/random/random.engine.mt19937.xml @@ -0,0 +1,67 @@ + + + The Random\Engine\Mt19937 class + Random\Engine\Mt19937 + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\Engine\Mt19937 + + + + + Random\Engine\Mt19937 + + + + Random\Engine + + + + + &Methods; + + + + +
+ +
+ + &reference.random.entities.random-engine-mt19937; + +
+ diff --git a/reference/random/random.engine.pcgoneseq128xslrr64.xml b/reference/random/random.engine.pcgoneseq128xslrr64.xml new file mode 100644 index 000000000000..2a394d2de5c1 --- /dev/null +++ b/reference/random/random.engine.pcgoneseq128xslrr64.xml @@ -0,0 +1,67 @@ + + + The Random\Engine\PcgOneseq128XslRr64 class + Random\Engine\PcgOneseq128XslRr64 + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\Engine\PcgOneseq128XslRr64 + + + + + Random\Engine\PcgOneseq128XslRr64 + + + + Random\Engine + + + + + &Methods; + + + + +
+ +
+ + &reference.random.entities.random-engine-pcgoneseq128xslrr64; + +
+ diff --git a/reference/random/random.engine.secure.xml b/reference/random/random.engine.secure.xml new file mode 100644 index 000000000000..c3dd9be12ed5 --- /dev/null +++ b/reference/random/random.engine.secure.xml @@ -0,0 +1,67 @@ + + + The Random\Engine\Secure class + Random\Engine\Secure + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\Engine\Secure + + + + + Random\Engine\Secure + + + + Random\CryptoSafeEngine + + + + + &Methods; + + + + +
+ +
+ + &reference.random.entities.random-engine-secure; + +
+ diff --git a/reference/random/random.engine.xml b/reference/random/random.engine.xml new file mode 100644 index 000000000000..4cc7f1bfb224 --- /dev/null +++ b/reference/random/random.engine.xml @@ -0,0 +1,63 @@ + + + The Random\Engine interface + Random\Engine + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\Engine + + + + + Random\Engine + + + + + &Methods; + + + + +
+ +
+ + &reference.random.entities.random-engine; + +
+ diff --git a/reference/random/random.engine.xoshiro256starstar.xml b/reference/random/random.engine.xoshiro256starstar.xml new file mode 100644 index 000000000000..d379b1d925ee --- /dev/null +++ b/reference/random/random.engine.xoshiro256starstar.xml @@ -0,0 +1,67 @@ + + + The Random\Engine\Xoshiro256StarStar class + Random\Engine\Xoshiro256StarStar + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\Engine\Xoshiro256StarStar + + + + + Random\Engine\Xoshiro256StarStar + + + + Random\Engine + + + + + &Methods; + + + + +
+ +
+ + &reference.random.entities.random-engine-xoshiro256starstar; + +
+ diff --git a/reference/random/random.randomerror.xml b/reference/random/random.randomerror.xml new file mode 100644 index 000000000000..7652360228ea --- /dev/null +++ b/reference/random/random.randomerror.xml @@ -0,0 +1,79 @@ + + + The Random\RandomError class + Random\RandomError + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\RandomError + + + + + Random\RandomError + + + + extends + Error + + + + Throwable + + + + &InheritedProperties; + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.random.entities.random-randomerror; + +
+ diff --git a/reference/random/random.randomexception.xml b/reference/random/random.randomexception.xml new file mode 100644 index 000000000000..8d31bcbb87c0 --- /dev/null +++ b/reference/random/random.randomexception.xml @@ -0,0 +1,79 @@ + + + The Random\RandomException class + Random\RandomException + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\RandomException + + + + + Random\RandomException + + + + extends + Exception + + + + Throwable + + + + &InheritedProperties; + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.random.entities.random-randomexception; + +
+ diff --git a/reference/random/random.randomizer.xml b/reference/random/random.randomizer.xml new file mode 100644 index 000000000000..148325f6b5ab --- /dev/null +++ b/reference/random/random.randomizer.xml @@ -0,0 +1,85 @@ + + + The Random\Randomizer class + Random\Randomizer + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Random\Randomizer + + + + + Random\Randomizer + + + + &Properties; + + Engine + engine + + + + &Methods; + + + + +
+ + + +
+ &reftitle.properties; + + + engine + + + + + +
+ + + +
+ + &reference.random.entities.random-randomizer; + +
+ diff --git a/reference/random/random/engine/generate.xml b/reference/random/random/engine/generate.xml new file mode 100644 index 000000000000..fe2becf39617 --- /dev/null +++ b/reference/random/random/engine/generate.xml @@ -0,0 +1,77 @@ + + + + Random\Engine::generate + Description + + + + &reftitle.description; + + abstract public stringRandom\Engine::generate + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine::generate</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/mt19937/construct.xml b/reference/random/random/engine/mt19937/construct.xml new file mode 100644 index 000000000000..2a8afe1f5210 --- /dev/null +++ b/reference/random/random/engine/mt19937/construct.xml @@ -0,0 +1,100 @@ + + + + Random\Engine\Mt19937::__construct + Description + + + + &reftitle.description; + + public Random\Engine\Mt19937::__construct + intnullseed + intmode + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + seed + + + + + + + + mode + + + + + + + + + + + + + + &reftitle.examples; + + <function>Random\Engine\Mt19937::__construct</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/mt19937/debuginfo.xml b/reference/random/random/engine/mt19937/debuginfo.xml new file mode 100644 index 000000000000..8150f15d8374 --- /dev/null +++ b/reference/random/random/engine/mt19937/debuginfo.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\Mt19937::__debugInfo + Description + + + + &reftitle.description; + + public arrayRandom\Engine\Mt19937::__debugInfo + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Mt19937::__debugInfo</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/mt19937/generate.xml b/reference/random/random/engine/mt19937/generate.xml new file mode 100644 index 000000000000..605af07798f1 --- /dev/null +++ b/reference/random/random/engine/mt19937/generate.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\Mt19937::generate + Description + + + + &reftitle.description; + + public stringRandom\Engine\Mt19937::generate + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Mt19937::generate</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/mt19937/serialize.xml b/reference/random/random/engine/mt19937/serialize.xml new file mode 100644 index 000000000000..42ff90744802 --- /dev/null +++ b/reference/random/random/engine/mt19937/serialize.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\Mt19937::__serialize + Description + + + + &reftitle.description; + + public arrayRandom\Engine\Mt19937::__serialize + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Mt19937::__serialize</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/mt19937/unserialize.xml b/reference/random/random/engine/mt19937/unserialize.xml new file mode 100644 index 000000000000..116f25b238c8 --- /dev/null +++ b/reference/random/random/engine/mt19937/unserialize.xml @@ -0,0 +1,86 @@ + + + + Random\Engine\Mt19937::__unserialize + Description + + + + &reftitle.description; + + public voidRandom\Engine\Mt19937::__unserialize + arraydata + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + data + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Mt19937::__unserialize</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml b/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml new file mode 100644 index 000000000000..93d26670cef4 --- /dev/null +++ b/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml @@ -0,0 +1,91 @@ + + + + Random\Engine\PcgOneseq128XslRr64::__construct + Description + + + + &reftitle.description; + + public Random\Engine\PcgOneseq128XslRr64::__construct + stringintnullseed + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + seed + + + + + + + + + + + + + + &reftitle.examples; + + <function>Random\Engine\PcgOneseq128XslRr64::__construct</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml b/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml new file mode 100644 index 000000000000..b5bb5ffa50a8 --- /dev/null +++ b/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\PcgOneseq128XslRr64::__debugInfo + Description + + + + &reftitle.description; + + public arrayRandom\Engine\PcgOneseq128XslRr64::__debugInfo + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\PcgOneseq128XslRr64::__debugInfo</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml b/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml new file mode 100644 index 000000000000..6a10fa0963e2 --- /dev/null +++ b/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\PcgOneseq128XslRr64::generate + Description + + + + &reftitle.description; + + public stringRandom\Engine\PcgOneseq128XslRr64::generate + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\PcgOneseq128XslRr64::generate</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml new file mode 100644 index 000000000000..4e906719fbc0 --- /dev/null +++ b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml @@ -0,0 +1,86 @@ + + + + Random\Engine\PcgOneseq128XslRr64::jump + Description + + + + &reftitle.description; + + public voidRandom\Engine\PcgOneseq128XslRr64::jump + intadvance + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + advance + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\PcgOneseq128XslRr64::jump</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml b/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml new file mode 100644 index 000000000000..69f19838d92d --- /dev/null +++ b/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\PcgOneseq128XslRr64::__serialize + Description + + + + &reftitle.description; + + public arrayRandom\Engine\PcgOneseq128XslRr64::__serialize + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\PcgOneseq128XslRr64::__serialize</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml b/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml new file mode 100644 index 000000000000..fd62e98203a7 --- /dev/null +++ b/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml @@ -0,0 +1,86 @@ + + + + Random\Engine\PcgOneseq128XslRr64::__unserialize + Description + + + + &reftitle.description; + + public voidRandom\Engine\PcgOneseq128XslRr64::__unserialize + arraydata + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + data + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\PcgOneseq128XslRr64::__unserialize</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/secure/generate.xml b/reference/random/random/engine/secure/generate.xml new file mode 100644 index 000000000000..c046b3348552 --- /dev/null +++ b/reference/random/random/engine/secure/generate.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\Secure::generate + Description + + + + &reftitle.description; + + public stringRandom\Engine\Secure::generate + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Secure::generate</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/xoshiro256starstar/construct.xml b/reference/random/random/engine/xoshiro256starstar/construct.xml new file mode 100644 index 000000000000..c02f1c98fa3f --- /dev/null +++ b/reference/random/random/engine/xoshiro256starstar/construct.xml @@ -0,0 +1,91 @@ + + + + Random\Engine\Xoshiro256StarStar::__construct + Description + + + + &reftitle.description; + + public Random\Engine\Xoshiro256StarStar::__construct + stringintnullseed + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + seed + + + + + + + + + + + + + + &reftitle.examples; + + <function>Random\Engine\Xoshiro256StarStar::__construct</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/xoshiro256starstar/debuginfo.xml b/reference/random/random/engine/xoshiro256starstar/debuginfo.xml new file mode 100644 index 000000000000..59030a2e9b5c --- /dev/null +++ b/reference/random/random/engine/xoshiro256starstar/debuginfo.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\Xoshiro256StarStar::__debugInfo + Description + + + + &reftitle.description; + + public arrayRandom\Engine\Xoshiro256StarStar::__debugInfo + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Xoshiro256StarStar::__debugInfo</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/xoshiro256starstar/generate.xml b/reference/random/random/engine/xoshiro256starstar/generate.xml new file mode 100644 index 000000000000..707ab14484d0 --- /dev/null +++ b/reference/random/random/engine/xoshiro256starstar/generate.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\Xoshiro256StarStar::generate + Description + + + + &reftitle.description; + + public stringRandom\Engine\Xoshiro256StarStar::generate + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Xoshiro256StarStar::generate</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/xoshiro256starstar/jump.xml b/reference/random/random/engine/xoshiro256starstar/jump.xml new file mode 100644 index 000000000000..cdc6b6ee7e82 --- /dev/null +++ b/reference/random/random/engine/xoshiro256starstar/jump.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\Xoshiro256StarStar::jump + Description + + + + &reftitle.description; + + public voidRandom\Engine\Xoshiro256StarStar::jump + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Xoshiro256StarStar::jump</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/xoshiro256starstar/jumplong.xml b/reference/random/random/engine/xoshiro256starstar/jumplong.xml new file mode 100644 index 000000000000..3ecb7b357e7a --- /dev/null +++ b/reference/random/random/engine/xoshiro256starstar/jumplong.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\Xoshiro256StarStar::jumpLong + Description + + + + &reftitle.description; + + public voidRandom\Engine\Xoshiro256StarStar::jumpLong + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Xoshiro256StarStar::jumpLong</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/xoshiro256starstar/serialize.xml b/reference/random/random/engine/xoshiro256starstar/serialize.xml new file mode 100644 index 000000000000..6f0767084edc --- /dev/null +++ b/reference/random/random/engine/xoshiro256starstar/serialize.xml @@ -0,0 +1,77 @@ + + + + Random\Engine\Xoshiro256StarStar::__serialize + Description + + + + &reftitle.description; + + public arrayRandom\Engine\Xoshiro256StarStar::__serialize + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Xoshiro256StarStar::__serialize</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/engine/xoshiro256starstar/unserialize.xml b/reference/random/random/engine/xoshiro256starstar/unserialize.xml new file mode 100644 index 000000000000..daefad2a288a --- /dev/null +++ b/reference/random/random/engine/xoshiro256starstar/unserialize.xml @@ -0,0 +1,86 @@ + + + + Random\Engine\Xoshiro256StarStar::__unserialize + Description + + + + &reftitle.description; + + public voidRandom\Engine\Xoshiro256StarStar::__unserialize + arraydata + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + data + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Engine\Xoshiro256StarStar::__unserialize</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/randomizer/construct.xml b/reference/random/random/randomizer/construct.xml new file mode 100644 index 000000000000..cf023232b9f7 --- /dev/null +++ b/reference/random/random/randomizer/construct.xml @@ -0,0 +1,91 @@ + + + + Random\Randomizer::__construct + Description + + + + &reftitle.description; + + public Random\Randomizer::__construct + Random\Enginenullengine + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + engine + + + + + + + + + + + + + + &reftitle.examples; + + <function>Random\Randomizer::__construct</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/randomizer/getbytes.xml b/reference/random/random/randomizer/getbytes.xml new file mode 100644 index 000000000000..5913b8abad2a --- /dev/null +++ b/reference/random/random/randomizer/getbytes.xml @@ -0,0 +1,86 @@ + + + + Random\Randomizer::getBytes + Description + + + + &reftitle.description; + + public stringRandom\Randomizer::getBytes + intlength + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + length + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Randomizer::getBytes</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/randomizer/getint.xml b/reference/random/random/randomizer/getint.xml new file mode 100644 index 000000000000..83f4950ea1fd --- /dev/null +++ b/reference/random/random/randomizer/getint.xml @@ -0,0 +1,95 @@ + + + + Random\Randomizer::getInt + Description + + + + &reftitle.description; + + public intRandom\Randomizer::getInt + intmin + intmax + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + min + + + + + + + + max + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Randomizer::getInt</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/randomizer/nextint.xml b/reference/random/random/randomizer/nextint.xml new file mode 100644 index 000000000000..f3e0ced02ad8 --- /dev/null +++ b/reference/random/random/randomizer/nextint.xml @@ -0,0 +1,77 @@ + + + + Random\Randomizer::nextInt + Description + + + + &reftitle.description; + + public intRandom\Randomizer::nextInt + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Randomizer::nextInt</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/randomizer/pickarraykeys.xml b/reference/random/random/randomizer/pickarraykeys.xml new file mode 100644 index 000000000000..fcd9bdd16f30 --- /dev/null +++ b/reference/random/random/randomizer/pickarraykeys.xml @@ -0,0 +1,95 @@ + + + + Random\Randomizer::pickArrayKeys + Description + + + + &reftitle.description; + + public arrayRandom\Randomizer::pickArrayKeys + arrayarray + intnum + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + array + + + + + + + + num + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Randomizer::pickArrayKeys</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/randomizer/serialize.xml b/reference/random/random/randomizer/serialize.xml new file mode 100644 index 000000000000..d9c87717b41d --- /dev/null +++ b/reference/random/random/randomizer/serialize.xml @@ -0,0 +1,77 @@ + + + + Random\Randomizer::__serialize + Description + + + + &reftitle.description; + + public arrayRandom\Randomizer::__serialize + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Randomizer::__serialize</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/randomizer/shufflearray.xml b/reference/random/random/randomizer/shufflearray.xml new file mode 100644 index 000000000000..a21f388b6954 --- /dev/null +++ b/reference/random/random/randomizer/shufflearray.xml @@ -0,0 +1,86 @@ + + + + Random\Randomizer::shuffleArray + Description + + + + &reftitle.description; + + public arrayRandom\Randomizer::shuffleArray + arrayarray + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + array + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Randomizer::shuffleArray</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/randomizer/shufflebytes.xml b/reference/random/random/randomizer/shufflebytes.xml new file mode 100644 index 000000000000..bc18e08b0b63 --- /dev/null +++ b/reference/random/random/randomizer/shufflebytes.xml @@ -0,0 +1,86 @@ + + + + Random\Randomizer::shuffleBytes + Description + + + + &reftitle.description; + + public stringRandom\Randomizer::shuffleBytes + stringbytes + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + bytes + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Randomizer::shuffleBytes</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/random/random/randomizer/unserialize.xml b/reference/random/random/randomizer/unserialize.xml new file mode 100644 index 000000000000..7444acd3c5c0 --- /dev/null +++ b/reference/random/random/randomizer/unserialize.xml @@ -0,0 +1,86 @@ + + + + Random\Randomizer::__unserialize + Description + + + + &reftitle.description; + + public voidRandom\Randomizer::__unserialize + arraydata + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + data + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Random\Randomizer::__unserialize</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + diff --git a/reference/csprng/reference.xml b/reference/random/reference.xml similarity index 73% rename from reference/csprng/reference.xml rename to reference/random/reference.xml index 09dea4f27a1a..2ca19f6c2a38 100644 --- a/reference/csprng/reference.xml +++ b/reference/random/reference.xml @@ -1,13 +1,10 @@ - + + Random &Functions; - - CSPRNG &Functions; - - &reference.csprng.entities.functions; + &reference.random.entities.functions; - - diff --git a/reference/csprng/setup.xml b/reference/random/setup.xml similarity index 72% rename from reference/csprng/setup.xml rename to reference/random/setup.xml index 790b1c921d8b..351c34b609ed 100644 --- a/reference/csprng/setup.xml +++ b/reference/random/setup.xml @@ -1,31 +1,28 @@ - - - + &reftitle.setup; -
+
&reftitle.required; &no.requirement;
-
+
&reftitle.install; &no.install;
-
+
&reftitle.runtime; &no.config;
-
+
&reftitle.resources; &no.resource;
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 1b895db5feeaf9dfab2e9fd9695375d619135ea8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Tue, 25 Oct 2022 21:14:17 +0200 Subject: [PATCH 02/17] Update ext/random versions --- reference/random/versions.xml | 140 +++++++++++++++++----------------- 1 file changed, 70 insertions(+), 70 deletions(-) diff --git a/reference/random/versions.xml b/reference/random/versions.xml index a3ebb6492e88..da0a3e0e6813 100644 --- a/reference/random/versions.xml +++ b/reference/random/versions.xml @@ -13,85 +13,85 @@ - - + + - - + + - - - - - - - - - - - + + + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - + + + + + + + - - - - - - - - + + + + + + + + - - + + - - - - - - - - - - + + + + + + + + + + @@ -54,8 +50,6 @@ - &reference.random.entities.random-brokenrandomengineerror; - - &Methods; - + @@ -42,8 +42,6 @@ - &reference.random.entities.random-cryptosafeengine; - &Methods; + @@ -42,7 +43,7 @@ - &reference.random.entities.random-engine-mt19937; + &reference.random.random.engine.entities.mt19937; &Methods; + @@ -42,7 +43,7 @@ - &reference.random.entities.random-engine-pcgoneseq128xslrr64; + &reference.random.random.engine.entities.pcgoneseq128xslrr64; &Methods; + @@ -42,7 +43,7 @@ - &reference.random.entities.random-engine-xoshiro256starstar; + &reference.random.random.engine.entities.xoshiro256starstar; @@ -60,7 +61,7 @@ - &reference.random.entities.random-randomizer; + &reference.random.random.entities.randomizer; - - - - -%xhtml-lat1; -%xhtml-symbol; -%xhtml-special; -%isopub; - - - - - - -%language-defs.default; -%extensions.default; -%language-snippets.default; - - - - - - - - - -%global.entities; -%file.entities; -%frontpage.entities; -]> - - - Random - Random - - - &reftitle.intro; - - - - - - &reference.random.setup; - &reference.random.constants; - &reference.random.examples; - &reference.random.reference; - - - From 91d72ecddaebcf521b0fc19643a000805655ee0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 18:48:41 +0200 Subject: [PATCH 07/17] random: Configure a proper book title --- reference/random/book.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/random/book.xml b/reference/random/book.xml index f12af5699516..8fc70ff418b9 100644 --- a/reference/random/book.xml +++ b/reference/random/book.xml @@ -1,8 +1,8 @@ - Random - Random + Random Number Generators and Functions Related to Randomness + random &reftitle.intro; From bed096e6c4659f65f2db1b3798579abbbcf20999 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 18:49:53 +0200 Subject: [PATCH 08/17] random: Add refpurpose to all methods --- reference/random/random/engine/generate.xml | 2 +- reference/random/random/engine/mt19937/construct.xml | 2 +- reference/random/random/engine/mt19937/debuginfo.xml | 2 +- reference/random/random/engine/mt19937/generate.xml | 2 +- reference/random/random/engine/mt19937/serialize.xml | 2 +- reference/random/random/engine/mt19937/unserialize.xml | 2 +- .../random/random/engine/pcgoneseq128xslrr64/construct.xml | 2 +- .../random/random/engine/pcgoneseq128xslrr64/debuginfo.xml | 2 +- reference/random/random/engine/pcgoneseq128xslrr64/generate.xml | 2 +- reference/random/random/engine/pcgoneseq128xslrr64/jump.xml | 2 +- .../random/random/engine/pcgoneseq128xslrr64/serialize.xml | 2 +- .../random/random/engine/pcgoneseq128xslrr64/unserialize.xml | 2 +- reference/random/random/engine/secure/generate.xml | 2 +- reference/random/random/engine/xoshiro256starstar/construct.xml | 2 +- reference/random/random/engine/xoshiro256starstar/debuginfo.xml | 2 +- reference/random/random/engine/xoshiro256starstar/generate.xml | 2 +- reference/random/random/engine/xoshiro256starstar/jump.xml | 2 +- reference/random/random/engine/xoshiro256starstar/jumplong.xml | 2 +- reference/random/random/engine/xoshiro256starstar/serialize.xml | 2 +- .../random/random/engine/xoshiro256starstar/unserialize.xml | 2 +- reference/random/random/randomizer/construct.xml | 2 +- reference/random/random/randomizer/getbytes.xml | 2 +- reference/random/random/randomizer/getint.xml | 2 +- reference/random/random/randomizer/nextint.xml | 2 +- reference/random/random/randomizer/pickarraykeys.xml | 2 +- reference/random/random/randomizer/serialize.xml | 2 +- reference/random/random/randomizer/shufflearray.xml | 2 +- reference/random/random/randomizer/shufflebytes.xml | 2 +- reference/random/random/randomizer/unserialize.xml | 2 +- 29 files changed, 29 insertions(+), 29 deletions(-) diff --git a/reference/random/random/engine/generate.xml b/reference/random/random/engine/generate.xml index fe2becf39617..59aa97606505 100644 --- a/reference/random/random/engine/generate.xml +++ b/reference/random/random/engine/generate.xml @@ -2,7 +2,7 @@ Random\Engine::generate - Description + Generates randomness diff --git a/reference/random/random/engine/mt19937/construct.xml b/reference/random/random/engine/mt19937/construct.xml index 2a8afe1f5210..d6c9f8359a3e 100644 --- a/reference/random/random/engine/mt19937/construct.xml +++ b/reference/random/random/engine/mt19937/construct.xml @@ -2,7 +2,7 @@ Random\Engine\Mt19937::__construct - Description + Constructs a new Mt19937 engine diff --git a/reference/random/random/engine/mt19937/debuginfo.xml b/reference/random/random/engine/mt19937/debuginfo.xml index 8150f15d8374..00a49c9a23b7 100644 --- a/reference/random/random/engine/mt19937/debuginfo.xml +++ b/reference/random/random/engine/mt19937/debuginfo.xml @@ -2,7 +2,7 @@ Random\Engine\Mt19937::__debugInfo - Description + Returns the internal state of the engine diff --git a/reference/random/random/engine/mt19937/generate.xml b/reference/random/random/engine/mt19937/generate.xml index 605af07798f1..e2776ccf5085 100644 --- a/reference/random/random/engine/mt19937/generate.xml +++ b/reference/random/random/engine/mt19937/generate.xml @@ -2,7 +2,7 @@ Random\Engine\Mt19937::generate - Description + Generates 32 Bits of randomness diff --git a/reference/random/random/engine/mt19937/serialize.xml b/reference/random/random/engine/mt19937/serialize.xml index 42ff90744802..dd82bc162801 100644 --- a/reference/random/random/engine/mt19937/serialize.xml +++ b/reference/random/random/engine/mt19937/serialize.xml @@ -2,7 +2,7 @@ Random\Engine\Mt19937::__serialize - Description + Serializes the Mt19937 object diff --git a/reference/random/random/engine/mt19937/unserialize.xml b/reference/random/random/engine/mt19937/unserialize.xml index 116f25b238c8..6adb25e76f05 100644 --- a/reference/random/random/engine/mt19937/unserialize.xml +++ b/reference/random/random/engine/mt19937/unserialize.xml @@ -2,7 +2,7 @@ Random\Engine\Mt19937::__unserialize - Description + Deserializes the data parameter into a Mt19937 object diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml b/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml index 93d26670cef4..e281db7127f5 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml @@ -2,7 +2,7 @@ Random\Engine\PcgOneseq128XslRr64::__construct - Description + Constructs a new PCG Oneseq 128 XSL RR 64 engine diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml b/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml index b5bb5ffa50a8..a4e11beeba37 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml @@ -2,7 +2,7 @@ Random\Engine\PcgOneseq128XslRr64::__debugInfo - Description + Returns the internal state of the engine diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml b/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml index 6a10fa0963e2..70e283570f6e 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml @@ -2,7 +2,7 @@ Random\Engine\PcgOneseq128XslRr64::generate - Description + Generates 64 Bits of randomness diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml index 4e906719fbc0..72c9a90fac7a 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml @@ -2,7 +2,7 @@ Random\Engine\PcgOneseq128XslRr64::jump - Description + Efficiently moves the engine ahead multiple steps diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml b/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml index 69f19838d92d..097b6026dc17 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml @@ -2,7 +2,7 @@ Random\Engine\PcgOneseq128XslRr64::__serialize - Description + Serializes the PcgOneseq128XslRr64 object diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml b/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml index fd62e98203a7..edc10207b6a0 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml @@ -2,7 +2,7 @@ Random\Engine\PcgOneseq128XslRr64::__unserialize - Description + Deserializes the data parameter into a PcgOneseq128XslRr64 object diff --git a/reference/random/random/engine/secure/generate.xml b/reference/random/random/engine/secure/generate.xml index c046b3348552..b772fc36dd87 100644 --- a/reference/random/random/engine/secure/generate.xml +++ b/reference/random/random/engine/secure/generate.xml @@ -2,7 +2,7 @@ Random\Engine\Secure::generate - Description + Generates cryptographically secure randomness diff --git a/reference/random/random/engine/xoshiro256starstar/construct.xml b/reference/random/random/engine/xoshiro256starstar/construct.xml index c02f1c98fa3f..80b11e87904d 100644 --- a/reference/random/random/engine/xoshiro256starstar/construct.xml +++ b/reference/random/random/engine/xoshiro256starstar/construct.xml @@ -2,7 +2,7 @@ Random\Engine\Xoshiro256StarStar::__construct - Description + Constructs a new xoshiro256** engine diff --git a/reference/random/random/engine/xoshiro256starstar/debuginfo.xml b/reference/random/random/engine/xoshiro256starstar/debuginfo.xml index 59030a2e9b5c..4c124da39e52 100644 --- a/reference/random/random/engine/xoshiro256starstar/debuginfo.xml +++ b/reference/random/random/engine/xoshiro256starstar/debuginfo.xml @@ -2,7 +2,7 @@ Random\Engine\Xoshiro256StarStar::__debugInfo - Description + Returns the internal state of the engine diff --git a/reference/random/random/engine/xoshiro256starstar/generate.xml b/reference/random/random/engine/xoshiro256starstar/generate.xml index 707ab14484d0..ec8d9ddf5643 100644 --- a/reference/random/random/engine/xoshiro256starstar/generate.xml +++ b/reference/random/random/engine/xoshiro256starstar/generate.xml @@ -2,7 +2,7 @@ Random\Engine\Xoshiro256StarStar::generate - Description + Generates 64 Bits of randomness diff --git a/reference/random/random/engine/xoshiro256starstar/jump.xml b/reference/random/random/engine/xoshiro256starstar/jump.xml index cdc6b6ee7e82..99df7948473b 100644 --- a/reference/random/random/engine/xoshiro256starstar/jump.xml +++ b/reference/random/random/engine/xoshiro256starstar/jump.xml @@ -2,7 +2,7 @@ Random\Engine\Xoshiro256StarStar::jump - Description + Efficiently moves the engine ahead by 2^128 steps diff --git a/reference/random/random/engine/xoshiro256starstar/jumplong.xml b/reference/random/random/engine/xoshiro256starstar/jumplong.xml index 3ecb7b357e7a..667c3c4d4095 100644 --- a/reference/random/random/engine/xoshiro256starstar/jumplong.xml +++ b/reference/random/random/engine/xoshiro256starstar/jumplong.xml @@ -2,7 +2,7 @@ Random\Engine\Xoshiro256StarStar::jumpLong - Description + Efficiently moves the engine ahead by 2^192 steps diff --git a/reference/random/random/engine/xoshiro256starstar/serialize.xml b/reference/random/random/engine/xoshiro256starstar/serialize.xml index 6f0767084edc..49ca6fe28a2d 100644 --- a/reference/random/random/engine/xoshiro256starstar/serialize.xml +++ b/reference/random/random/engine/xoshiro256starstar/serialize.xml @@ -2,7 +2,7 @@ Random\Engine\Xoshiro256StarStar::__serialize - Description + Serializes the Xoshiro256StarStar object diff --git a/reference/random/random/engine/xoshiro256starstar/unserialize.xml b/reference/random/random/engine/xoshiro256starstar/unserialize.xml index daefad2a288a..213ab1d0f2b1 100644 --- a/reference/random/random/engine/xoshiro256starstar/unserialize.xml +++ b/reference/random/random/engine/xoshiro256starstar/unserialize.xml @@ -2,7 +2,7 @@ Random\Engine\Xoshiro256StarStar::__unserialize - Description + Deserializes the data parameter into a Xoshiro256StarStar object diff --git a/reference/random/random/randomizer/construct.xml b/reference/random/random/randomizer/construct.xml index cf023232b9f7..453adcaa7f73 100644 --- a/reference/random/random/randomizer/construct.xml +++ b/reference/random/random/randomizer/construct.xml @@ -2,7 +2,7 @@ Random\Randomizer::__construct - Description + Constructs a new Randomizer diff --git a/reference/random/random/randomizer/getbytes.xml b/reference/random/random/randomizer/getbytes.xml index 5913b8abad2a..7e9953fe8a28 100644 --- a/reference/random/random/randomizer/getbytes.xml +++ b/reference/random/random/randomizer/getbytes.xml @@ -2,7 +2,7 @@ Random\Randomizer::getBytes - Description + Get random bytes diff --git a/reference/random/random/randomizer/getint.xml b/reference/random/random/randomizer/getint.xml index 83f4950ea1fd..4cc14845ad29 100644 --- a/reference/random/random/randomizer/getint.xml +++ b/reference/random/random/randomizer/getint.xml @@ -2,7 +2,7 @@ Random\Randomizer::getInt - Description + Get a uniformly chosen integer from an interval diff --git a/reference/random/random/randomizer/nextint.xml b/reference/random/random/randomizer/nextint.xml index f3e0ced02ad8..db1d632af0d4 100644 --- a/reference/random/random/randomizer/nextint.xml +++ b/reference/random/random/randomizer/nextint.xml @@ -2,7 +2,7 @@ Random\Randomizer::nextInt - Description + Get a positive integer diff --git a/reference/random/random/randomizer/pickarraykeys.xml b/reference/random/random/randomizer/pickarraykeys.xml index fcd9bdd16f30..5dcb96945869 100644 --- a/reference/random/random/randomizer/pickarraykeys.xml +++ b/reference/random/random/randomizer/pickarraykeys.xml @@ -2,7 +2,7 @@ Random\Randomizer::pickArrayKeys - Description + Select random array keys diff --git a/reference/random/random/randomizer/serialize.xml b/reference/random/random/randomizer/serialize.xml index d9c87717b41d..9f9e52f8a4ff 100644 --- a/reference/random/random/randomizer/serialize.xml +++ b/reference/random/random/randomizer/serialize.xml @@ -2,7 +2,7 @@ Random\Randomizer::__serialize - Description + Serializes the Randomizer object diff --git a/reference/random/random/randomizer/shufflearray.xml b/reference/random/random/randomizer/shufflearray.xml index a21f388b6954..c45dc3a3ec04 100644 --- a/reference/random/random/randomizer/shufflearray.xml +++ b/reference/random/random/randomizer/shufflearray.xml @@ -2,7 +2,7 @@ Random\Randomizer::shuffleArray - Description + Shuffle the values of an array diff --git a/reference/random/random/randomizer/shufflebytes.xml b/reference/random/random/randomizer/shufflebytes.xml index bc18e08b0b63..d2e1e7bbc750 100644 --- a/reference/random/random/randomizer/shufflebytes.xml +++ b/reference/random/random/randomizer/shufflebytes.xml @@ -2,7 +2,7 @@ Random\Randomizer::shuffleBytes - Description + Shuffle the bytes of a string diff --git a/reference/random/random/randomizer/unserialize.xml b/reference/random/random/randomizer/unserialize.xml index 7444acd3c5c0..3698696313f7 100644 --- a/reference/random/random/randomizer/unserialize.xml +++ b/reference/random/random/randomizer/unserialize.xml @@ -2,7 +2,7 @@ Random\Randomizer::__unserialize - Description + Deserializes the data parameter into a Randomizer object From c9f249ce1150dab173416b2104d8487e0172bbd4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 18:57:13 +0200 Subject: [PATCH 09/17] random: Add `&return.void;` --- reference/random/random/engine/mt19937/unserialize.xml | 2 +- reference/random/random/engine/pcgoneseq128xslrr64/jump.xml | 2 +- .../random/random/engine/pcgoneseq128xslrr64/unserialize.xml | 2 +- reference/random/random/engine/xoshiro256starstar/jump.xml | 2 +- reference/random/random/engine/xoshiro256starstar/jumplong.xml | 2 +- .../random/random/engine/xoshiro256starstar/unserialize.xml | 2 +- reference/random/random/randomizer/unserialize.xml | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/reference/random/random/engine/mt19937/unserialize.xml b/reference/random/random/engine/mt19937/unserialize.xml index 6adb25e76f05..a08501b849b5 100644 --- a/reference/random/random/engine/mt19937/unserialize.xml +++ b/reference/random/random/engine/mt19937/unserialize.xml @@ -36,7 +36,7 @@ &reftitle.returnvalues; - + &return.void; diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml index 72c9a90fac7a..ba978d7529e6 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml @@ -36,7 +36,7 @@ &reftitle.returnvalues; - + &return.void; diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml b/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml index edc10207b6a0..901d17a93968 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml @@ -36,7 +36,7 @@ &reftitle.returnvalues; - + &return.void; diff --git a/reference/random/random/engine/xoshiro256starstar/jump.xml b/reference/random/random/engine/xoshiro256starstar/jump.xml index 99df7948473b..b03c04d44ebf 100644 --- a/reference/random/random/engine/xoshiro256starstar/jump.xml +++ b/reference/random/random/engine/xoshiro256starstar/jump.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + &return.void; diff --git a/reference/random/random/engine/xoshiro256starstar/jumplong.xml b/reference/random/random/engine/xoshiro256starstar/jumplong.xml index 667c3c4d4095..e432f092bc2a 100644 --- a/reference/random/random/engine/xoshiro256starstar/jumplong.xml +++ b/reference/random/random/engine/xoshiro256starstar/jumplong.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + &return.void; diff --git a/reference/random/random/engine/xoshiro256starstar/unserialize.xml b/reference/random/random/engine/xoshiro256starstar/unserialize.xml index 213ab1d0f2b1..0e5a90b01a9a 100644 --- a/reference/random/random/engine/xoshiro256starstar/unserialize.xml +++ b/reference/random/random/engine/xoshiro256starstar/unserialize.xml @@ -36,7 +36,7 @@ &reftitle.returnvalues; - + &return.void; diff --git a/reference/random/random/randomizer/unserialize.xml b/reference/random/random/randomizer/unserialize.xml index 3698696313f7..0df450f1f3d1 100644 --- a/reference/random/random/randomizer/unserialize.xml +++ b/reference/random/random/randomizer/unserialize.xml @@ -36,7 +36,7 @@ &reftitle.returnvalues; - + &return.void; From 018f23842c926a98b3a09abfb1f68294a46eff03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 19:01:55 +0200 Subject: [PATCH 10/17] random: Add introduction to all engines --- reference/random/random.engine.mt19937.xml | 2 +- reference/random/random.engine.pcgoneseq128xslrr64.xml | 2 +- reference/random/random.engine.secure.xml | 2 +- reference/random/random.engine.xoshiro256starstar.xml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/random/random.engine.mt19937.xml b/reference/random/random.engine.mt19937.xml index dd4d5764210e..1a77b9ff9785 100644 --- a/reference/random/random.engine.mt19937.xml +++ b/reference/random/random.engine.mt19937.xml @@ -9,7 +9,7 @@
&reftitle.intro; - + Implements the Mt19937 (“Mersenne Twister”) algorithm.
diff --git a/reference/random/random.engine.pcgoneseq128xslrr64.xml b/reference/random/random.engine.pcgoneseq128xslrr64.xml index b3119fde580d..af91c8f89ce2 100644 --- a/reference/random/random.engine.pcgoneseq128xslrr64.xml +++ b/reference/random/random.engine.pcgoneseq128xslrr64.xml @@ -9,7 +9,7 @@
&reftitle.intro; - + Implements a Permuted congruential generator (PCG) with 128 Bits of state, XSL and RR transformations and 64 Bits output.
diff --git a/reference/random/random.engine.secure.xml b/reference/random/random.engine.secure.xml index e85b47896bde..b8378ba09aa5 100644 --- a/reference/random/random.engine.secure.xml +++ b/reference/random/random.engine.secure.xml @@ -9,7 +9,7 @@
&reftitle.intro; - + Generates cryptographically secure randomness using the operating system’s CSPRNG.
diff --git a/reference/random/random.engine.xoshiro256starstar.xml b/reference/random/random.engine.xoshiro256starstar.xml index cc4ae12f976b..eb507eb70f64 100644 --- a/reference/random/random.engine.xoshiro256starstar.xml +++ b/reference/random/random.engine.xoshiro256starstar.xml @@ -9,7 +9,7 @@
&reftitle.intro; - + Implements the xoshiro256** algorithm.
From 7d10e1def15165af3542741ad7d55643b0a8a5ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 19:05:21 +0200 Subject: [PATCH 11/17] random: Add introduction to Randomizer --- reference/random/random.randomizer.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/random/random.randomizer.xml b/reference/random/random.randomizer.xml index cbad35f9219d..32908bdf50a7 100644 --- a/reference/random/random.randomizer.xml +++ b/reference/random/random.randomizer.xml @@ -9,7 +9,7 @@
&reftitle.intro; - + Provides a high-level API to the randomness provided by an Random\Engine.
From 09c519e6a206e23994f3621320a1badeb518bf9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 19:08:55 +0200 Subject: [PATCH 12/17] random: Add default value for Randomizer::__construct()'s engine --- reference/random/random/randomizer/construct.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/random/random/randomizer/construct.xml b/reference/random/random/randomizer/construct.xml index 453adcaa7f73..d2199eaf6b38 100644 --- a/reference/random/random/randomizer/construct.xml +++ b/reference/random/random/randomizer/construct.xml @@ -9,7 +9,7 @@ &reftitle.description; public Random\Randomizer::__construct - Random\Enginenullengine + Random\Enginenullenginenew Random\Engine\Secure() From e123356c04fd629dd28b8ed1cc4b86a4c6c6f9c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 19:10:45 +0200 Subject: [PATCH 13/17] random: Add missing modifiers to Randomizer::$engine --- reference/random/random.randomizer.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/reference/random/random.randomizer.xml b/reference/random/random.randomizer.xml index 32908bdf50a7..f47daa4d7572 100644 --- a/reference/random/random.randomizer.xml +++ b/reference/random/random.randomizer.xml @@ -30,6 +30,8 @@ &Properties; + public + readonly Engine engine From afcd87b52987eb55cda446d7656ca0189d1fd1b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 19:15:42 +0200 Subject: [PATCH 14/17] random: Make interfaces actually interfaces --- reference/random/random.cryptosafeengine.xml | 8 ++++---- reference/random/random.engine.xml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/reference/random/random.cryptosafeengine.xml b/reference/random/random.cryptosafeengine.xml index 75c94d8a9ffe..00bd1c256cd2 100644 --- a/reference/random/random.cryptosafeengine.xml +++ b/reference/random/random.cryptosafeengine.xml @@ -15,7 +15,7 @@
- &reftitle.classsynopsis; + &reftitle.interfacesynopsis; @@ -23,9 +23,9 @@ - - Random\CryptoSafeEngine - + + Random\CryptoSafeEngine + Random\Engine diff --git a/reference/random/random.engine.xml b/reference/random/random.engine.xml index 65743293a71b..07ea8d80dff3 100644 --- a/reference/random/random.engine.xml +++ b/reference/random/random.engine.xml @@ -15,7 +15,7 @@
- &reftitle.classsynopsis; + &reftitle.interfacesynopsis; @@ -23,9 +23,9 @@ - - Random\Engine - + + Random\Engine + From 4910926d47fa323770d587f6ed1308266ebe019d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 19:17:59 +0200 Subject: [PATCH 15/17] random: Add description to BrokenRandomEngineError --- reference/random/random.brokenrandomengineerror.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/random/random.brokenrandomengineerror.xml b/reference/random/random.brokenrandomengineerror.xml index e0faa2cbb14e..aca7e4647815 100644 --- a/reference/random/random.brokenrandomengineerror.xml +++ b/reference/random/random.brokenrandomengineerror.xml @@ -9,7 +9,7 @@
&reftitle.intro; - + Indicates that the used Random\Engine is broken, e.g. because it is severely biased.
From 8fccb07fff26aa641f3647c39385597a5aee3571 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 26 Oct 2022 19:27:32 +0200 Subject: [PATCH 16/17] random: Add `final` modifier to relevant classes --- reference/random/random.engine.mt19937.xml | 1 + reference/random/random.engine.pcgoneseq128xslrr64.xml | 1 + reference/random/random.engine.secure.xml | 1 + reference/random/random.engine.xoshiro256starstar.xml | 1 + reference/random/random.randomizer.xml | 1 + 5 files changed, 5 insertions(+) diff --git a/reference/random/random.engine.mt19937.xml b/reference/random/random.engine.mt19937.xml index 1a77b9ff9785..ac0a08edee54 100644 --- a/reference/random/random.engine.mt19937.xml +++ b/reference/random/random.engine.mt19937.xml @@ -24,6 +24,7 @@ + final Random\Engine\Mt19937 diff --git a/reference/random/random.engine.pcgoneseq128xslrr64.xml b/reference/random/random.engine.pcgoneseq128xslrr64.xml index af91c8f89ce2..d23f6cc97e5d 100644 --- a/reference/random/random.engine.pcgoneseq128xslrr64.xml +++ b/reference/random/random.engine.pcgoneseq128xslrr64.xml @@ -24,6 +24,7 @@ + final Random\Engine\PcgOneseq128XslRr64 diff --git a/reference/random/random.engine.secure.xml b/reference/random/random.engine.secure.xml index b8378ba09aa5..b8febc1d247a 100644 --- a/reference/random/random.engine.secure.xml +++ b/reference/random/random.engine.secure.xml @@ -24,6 +24,7 @@ + final Random\Engine\Secure diff --git a/reference/random/random.engine.xoshiro256starstar.xml b/reference/random/random.engine.xoshiro256starstar.xml index eb507eb70f64..697ca5f68685 100644 --- a/reference/random/random.engine.xoshiro256starstar.xml +++ b/reference/random/random.engine.xoshiro256starstar.xml @@ -24,6 +24,7 @@ + final Random\Engine\Xoshiro256StarStar diff --git a/reference/random/random.randomizer.xml b/reference/random/random.randomizer.xml index f47daa4d7572..d65e9e3606e5 100644 --- a/reference/random/random.randomizer.xml +++ b/reference/random/random.randomizer.xml @@ -24,6 +24,7 @@ + final Random\Randomizer From 2d16e83b7cd6e551bce5a270c89fc601fbf8c546 Mon Sep 17 00:00:00 2001 From: "Christoph M. Becker" Date: Thu, 27 Oct 2022 17:14:48 +0200 Subject: [PATCH 17/17] Remove trailing whitespace --- reference/random/functions/getrandmax.xml | 2 +- reference/random/functions/lcg-value.xml | 2 +- reference/random/functions/mt-getrandmax.xml | 4 ++-- reference/random/functions/mt-rand.xml | 2 +- reference/random/functions/mt-srand.xml | 10 +++++----- reference/random/functions/rand.xml | 4 ++-- reference/random/random.brokenrandomengineerror.xml | 4 ++-- reference/random/random.cryptosafeengine.xml | 4 ++-- reference/random/random.engine.mt19937.xml | 4 ++-- reference/random/random.engine.pcgoneseq128xslrr64.xml | 4 ++-- reference/random/random.engine.secure.xml | 4 ++-- reference/random/random.engine.xml | 2 +- reference/random/random.engine.xoshiro256starstar.xml | 4 ++-- reference/random/random.randomerror.xml | 4 ++-- reference/random/random.randomexception.xml | 4 ++-- reference/random/random.randomizer.xml | 4 ++-- reference/random/random/engine/generate.xml | 2 +- reference/random/random/engine/mt19937/construct.xml | 6 +++--- reference/random/random/engine/mt19937/debuginfo.xml | 2 +- reference/random/random/engine/mt19937/generate.xml | 2 +- reference/random/random/engine/mt19937/serialize.xml | 2 +- reference/random/random/engine/mt19937/unserialize.xml | 2 +- .../random/engine/pcgoneseq128xslrr64/construct.xml | 4 ++-- .../random/engine/pcgoneseq128xslrr64/debuginfo.xml | 2 +- .../random/engine/pcgoneseq128xslrr64/generate.xml | 2 +- .../random/random/engine/pcgoneseq128xslrr64/jump.xml | 2 +- .../random/engine/pcgoneseq128xslrr64/serialize.xml | 2 +- .../random/engine/pcgoneseq128xslrr64/unserialize.xml | 2 +- reference/random/random/engine/secure/generate.xml | 2 +- .../random/engine/xoshiro256starstar/construct.xml | 4 ++-- .../random/engine/xoshiro256starstar/debuginfo.xml | 2 +- .../random/engine/xoshiro256starstar/generate.xml | 2 +- .../random/engine/xoshiro256starstar/serialize.xml | 2 +- .../random/engine/xoshiro256starstar/unserialize.xml | 2 +- reference/random/random/randomizer/construct.xml | 4 ++-- reference/random/random/randomizer/getbytes.xml | 4 ++-- reference/random/random/randomizer/getint.xml | 6 +++--- reference/random/random/randomizer/nextint.xml | 2 +- reference/random/random/randomizer/pickarraykeys.xml | 6 +++--- reference/random/random/randomizer/serialize.xml | 2 +- reference/random/random/randomizer/shufflearray.xml | 4 ++-- reference/random/random/randomizer/shufflebytes.xml | 4 ++-- reference/random/random/randomizer/unserialize.xml | 2 +- 43 files changed, 70 insertions(+), 70 deletions(-) diff --git a/reference/random/functions/getrandmax.xml b/reference/random/functions/getrandmax.xml index 911f4fbc9900..6ffcef02583b 100644 --- a/reference/random/functions/getrandmax.xml +++ b/reference/random/functions/getrandmax.xml @@ -21,7 +21,7 @@ &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; diff --git a/reference/random/functions/lcg-value.xml b/reference/random/functions/lcg-value.xml index e12a9d4cedef..ae9ce92bf643 100644 --- a/reference/random/functions/lcg-value.xml +++ b/reference/random/functions/lcg-value.xml @@ -24,7 +24,7 @@ &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; diff --git a/reference/random/functions/mt-getrandmax.xml b/reference/random/functions/mt-getrandmax.xml index 3e533ba4356f..2586ad6af437 100644 --- a/reference/random/functions/mt-getrandmax.xml +++ b/reference/random/functions/mt-getrandmax.xml @@ -21,12 +21,12 @@ &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; Returns the maximum random value returned by a call to - mt_rand without arguments, which is the maximum value + mt_rand without arguments, which is the maximum value that can be used for its max parameter without the result being scaled up (and therefore less random). diff --git a/reference/random/functions/mt-rand.xml b/reference/random/functions/mt-rand.xml index 91d90aa4cbcf..f59743312475 100644 --- a/reference/random/functions/mt-rand.xml +++ b/reference/random/functions/mt-rand.xml @@ -19,7 +19,7 @@ &caution.cryptographically-insecure; Many random number generators of older libcs - have dubious or unknown characteristics and are slow. + have dubious or unknown characteristics and are slow. The mt_rand function is a drop-in replacement for the older rand. It uses a random number generator with known characteristics using the diff --git a/reference/random/functions/mt-srand.xml b/reference/random/functions/mt-srand.xml index fc37e5bc2f2c..fff61ee2a13d 100644 --- a/reference/random/functions/mt-srand.xml +++ b/reference/random/functions/mt-srand.xml @@ -17,9 +17,9 @@ seed or with a random value if no seed is given. - + ¬e.randomseed; - + &reftitle.parameters; @@ -56,7 +56,7 @@ MT_RAND_PHP - Uses an incorrect Mersenne Twister implementation which was used as the default up till PHP 7.1.0. + Uses an incorrect Mersenne Twister implementation which was used as the default up till PHP 7.1.0. This mode is available for backward compatibility. @@ -69,14 +69,14 @@ - + &reftitle.returnvalues; &return.void; - + &reftitle.changelog; diff --git a/reference/random/functions/rand.xml b/reference/random/functions/rand.xml index 8d36cb67feb3..9829b789a51e 100644 --- a/reference/random/functions/rand.xml +++ b/reference/random/functions/rand.xml @@ -126,7 +126,7 @@ echo rand(5, 15); - + &reftitle.notes; @@ -138,7 +138,7 @@ echo rand(5, 15); - + &reftitle.seealso; diff --git a/reference/random/random.brokenrandomengineerror.xml b/reference/random/random.brokenrandomengineerror.xml index aca7e4647815..b71f82405fb2 100644 --- a/reference/random/random.brokenrandomengineerror.xml +++ b/reference/random/random.brokenrandomengineerror.xml @@ -26,12 +26,12 @@ Random\BrokenRandomEngineError - + extends Random\RandomError - + Throwable diff --git a/reference/random/random.cryptosafeengine.xml b/reference/random/random.cryptosafeengine.xml index 00bd1c256cd2..61a85e28c5bf 100644 --- a/reference/random/random.cryptosafeengine.xml +++ b/reference/random/random.cryptosafeengine.xml @@ -26,13 +26,13 @@ Random\CryptoSafeEngine - + Random\Engine - +
diff --git a/reference/random/random.engine.mt19937.xml b/reference/random/random.engine.mt19937.xml index ac0a08edee54..b2aeae452d34 100644 --- a/reference/random/random.engine.mt19937.xml +++ b/reference/random/random.engine.mt19937.xml @@ -27,13 +27,13 @@ final Random\Engine\Mt19937 - + Random\Engine - + &Methods; diff --git a/reference/random/random.engine.pcgoneseq128xslrr64.xml b/reference/random/random.engine.pcgoneseq128xslrr64.xml index d23f6cc97e5d..ca7e3704d1a6 100644 --- a/reference/random/random.engine.pcgoneseq128xslrr64.xml +++ b/reference/random/random.engine.pcgoneseq128xslrr64.xml @@ -27,13 +27,13 @@ final Random\Engine\PcgOneseq128XslRr64 - + Random\Engine - + &Methods; diff --git a/reference/random/random.engine.secure.xml b/reference/random/random.engine.secure.xml index b8febc1d247a..86b4cfe36aa7 100644 --- a/reference/random/random.engine.secure.xml +++ b/reference/random/random.engine.secure.xml @@ -27,13 +27,13 @@ final Random\Engine\Secure - + Random\CryptoSafeEngine - + &Methods; diff --git a/reference/random/random.engine.xml b/reference/random/random.engine.xml index 07ea8d80dff3..25800c9346cb 100644 --- a/reference/random/random.engine.xml +++ b/reference/random/random.engine.xml @@ -28,7 +28,7 @@ - + &Methods; diff --git a/reference/random/random.engine.xoshiro256starstar.xml b/reference/random/random.engine.xoshiro256starstar.xml index 697ca5f68685..921f0c5a91bb 100644 --- a/reference/random/random.engine.xoshiro256starstar.xml +++ b/reference/random/random.engine.xoshiro256starstar.xml @@ -27,13 +27,13 @@ final Random\Engine\Xoshiro256StarStar - + Random\Engine - + &Methods; diff --git a/reference/random/random.randomerror.xml b/reference/random/random.randomerror.xml index 91279c9eed55..a6992be66414 100644 --- a/reference/random/random.randomerror.xml +++ b/reference/random/random.randomerror.xml @@ -26,12 +26,12 @@ Random\RandomError - + extends Error - + Throwable diff --git a/reference/random/random.randomexception.xml b/reference/random/random.randomexception.xml index c7fb76ab7cb1..31659d180457 100644 --- a/reference/random/random.randomexception.xml +++ b/reference/random/random.randomexception.xml @@ -26,12 +26,12 @@ Random\RandomException - + extends Exception - + Throwable diff --git a/reference/random/random.randomizer.xml b/reference/random/random.randomizer.xml index d65e9e3606e5..378af106738d 100644 --- a/reference/random/random.randomizer.xml +++ b/reference/random/random.randomizer.xml @@ -37,7 +37,7 @@ engine - + &Methods; @@ -46,7 +46,7 @@
- +
&reftitle.properties; diff --git a/reference/random/random/engine/generate.xml b/reference/random/random/engine/generate.xml index 59aa97606505..094839f66ed3 100644 --- a/reference/random/random/engine/generate.xml +++ b/reference/random/random/engine/generate.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/mt19937/construct.xml b/reference/random/random/engine/mt19937/construct.xml index d6c9f8359a3e..f2e0e0b0e2d4 100644 --- a/reference/random/random/engine/mt19937/construct.xml +++ b/reference/random/random/engine/mt19937/construct.xml @@ -27,7 +27,7 @@ seed - + @@ -35,7 +35,7 @@ mode - + @@ -48,7 +48,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/random/random/engine/mt19937/debuginfo.xml b/reference/random/random/engine/mt19937/debuginfo.xml index 00a49c9a23b7..493e551eab53 100644 --- a/reference/random/random/engine/mt19937/debuginfo.xml +++ b/reference/random/random/engine/mt19937/debuginfo.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/mt19937/generate.xml b/reference/random/random/engine/mt19937/generate.xml index e2776ccf5085..3e4be1a57e40 100644 --- a/reference/random/random/engine/mt19937/generate.xml +++ b/reference/random/random/engine/mt19937/generate.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/mt19937/serialize.xml b/reference/random/random/engine/mt19937/serialize.xml index dd82bc162801..62043c9c17de 100644 --- a/reference/random/random/engine/mt19937/serialize.xml +++ b/reference/random/random/engine/mt19937/serialize.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/mt19937/unserialize.xml b/reference/random/random/engine/mt19937/unserialize.xml index a08501b849b5..77b2d1e11095 100644 --- a/reference/random/random/engine/mt19937/unserialize.xml +++ b/reference/random/random/engine/mt19937/unserialize.xml @@ -26,7 +26,7 @@ data - + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml b/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml index e281db7127f5..fafc5ba55664 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/construct.xml @@ -26,7 +26,7 @@ seed - + @@ -39,7 +39,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml b/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml index a4e11beeba37..7556a0606c66 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml b/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml index 70e283570f6e..af464611be7b 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml index ba978d7529e6..3321f091b940 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml @@ -26,7 +26,7 @@ advance - + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml b/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml index 097b6026dc17..e9c8d04d3d50 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml b/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml index 901d17a93968..889893623143 100644 --- a/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml +++ b/reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml @@ -26,7 +26,7 @@ data - + diff --git a/reference/random/random/engine/secure/generate.xml b/reference/random/random/engine/secure/generate.xml index b772fc36dd87..cb5acd561410 100644 --- a/reference/random/random/engine/secure/generate.xml +++ b/reference/random/random/engine/secure/generate.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/xoshiro256starstar/construct.xml b/reference/random/random/engine/xoshiro256starstar/construct.xml index 80b11e87904d..00e4fca63b17 100644 --- a/reference/random/random/engine/xoshiro256starstar/construct.xml +++ b/reference/random/random/engine/xoshiro256starstar/construct.xml @@ -26,7 +26,7 @@ seed - + @@ -39,7 +39,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/random/random/engine/xoshiro256starstar/debuginfo.xml b/reference/random/random/engine/xoshiro256starstar/debuginfo.xml index 4c124da39e52..62417c39a92a 100644 --- a/reference/random/random/engine/xoshiro256starstar/debuginfo.xml +++ b/reference/random/random/engine/xoshiro256starstar/debuginfo.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/xoshiro256starstar/generate.xml b/reference/random/random/engine/xoshiro256starstar/generate.xml index ec8d9ddf5643..b5dfc0026b94 100644 --- a/reference/random/random/engine/xoshiro256starstar/generate.xml +++ b/reference/random/random/engine/xoshiro256starstar/generate.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/xoshiro256starstar/serialize.xml b/reference/random/random/engine/xoshiro256starstar/serialize.xml index 49ca6fe28a2d..eb3174b3e453 100644 --- a/reference/random/random/engine/xoshiro256starstar/serialize.xml +++ b/reference/random/random/engine/xoshiro256starstar/serialize.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/engine/xoshiro256starstar/unserialize.xml b/reference/random/random/engine/xoshiro256starstar/unserialize.xml index 0e5a90b01a9a..de63aca53ec7 100644 --- a/reference/random/random/engine/xoshiro256starstar/unserialize.xml +++ b/reference/random/random/engine/xoshiro256starstar/unserialize.xml @@ -26,7 +26,7 @@ data - + diff --git a/reference/random/random/randomizer/construct.xml b/reference/random/random/randomizer/construct.xml index d2199eaf6b38..930baebbdee6 100644 --- a/reference/random/random/randomizer/construct.xml +++ b/reference/random/random/randomizer/construct.xml @@ -26,7 +26,7 @@ engine - + @@ -39,7 +39,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/random/random/randomizer/getbytes.xml b/reference/random/random/randomizer/getbytes.xml index 7e9953fe8a28..e604fd1d3267 100644 --- a/reference/random/random/randomizer/getbytes.xml +++ b/reference/random/random/randomizer/getbytes.xml @@ -26,7 +26,7 @@ length - + @@ -36,7 +36,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/randomizer/getint.xml b/reference/random/random/randomizer/getint.xml index 4cc14845ad29..00897d73f1b5 100644 --- a/reference/random/random/randomizer/getint.xml +++ b/reference/random/random/randomizer/getint.xml @@ -27,7 +27,7 @@ min - + @@ -35,7 +35,7 @@ max - + @@ -45,7 +45,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/randomizer/nextint.xml b/reference/random/random/randomizer/nextint.xml index db1d632af0d4..98b8862fdc4c 100644 --- a/reference/random/random/randomizer/nextint.xml +++ b/reference/random/random/randomizer/nextint.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/randomizer/pickarraykeys.xml b/reference/random/random/randomizer/pickarraykeys.xml index 5dcb96945869..5689d8b00b0d 100644 --- a/reference/random/random/randomizer/pickarraykeys.xml +++ b/reference/random/random/randomizer/pickarraykeys.xml @@ -27,7 +27,7 @@ array - + @@ -35,7 +35,7 @@ num - + @@ -45,7 +45,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/randomizer/serialize.xml b/reference/random/random/randomizer/serialize.xml index 9f9e52f8a4ff..f68d5f796a57 100644 --- a/reference/random/random/randomizer/serialize.xml +++ b/reference/random/random/randomizer/serialize.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/randomizer/shufflearray.xml b/reference/random/random/randomizer/shufflearray.xml index c45dc3a3ec04..c52293d939db 100644 --- a/reference/random/random/randomizer/shufflearray.xml +++ b/reference/random/random/randomizer/shufflearray.xml @@ -26,7 +26,7 @@ array - + @@ -36,7 +36,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/randomizer/shufflebytes.xml b/reference/random/random/randomizer/shufflebytes.xml index d2e1e7bbc750..627e9c15fa03 100644 --- a/reference/random/random/randomizer/shufflebytes.xml +++ b/reference/random/random/randomizer/shufflebytes.xml @@ -26,7 +26,7 @@ bytes - + @@ -36,7 +36,7 @@ &reftitle.returnvalues; - + diff --git a/reference/random/random/randomizer/unserialize.xml b/reference/random/random/randomizer/unserialize.xml index 0df450f1f3d1..6aa8dec2edcd 100644 --- a/reference/random/random/randomizer/unserialize.xml +++ b/reference/random/random/randomizer/unserialize.xml @@ -26,7 +26,7 @@ data - +