* random: Remove redundant “Returns” prefix from return value explanation
* random: Document Engine::generate()'s return value
* random: Document Xoshiro256StarStar::generate()'s return value
* random: Document PcgOneseq128XslRr64::generate()'s return value
* random: Document Mt19937::generate()'s return value
* random: Document Secure::generate()'s return value
* random: Document the Randomizer::$engine property
* random: Clarify the int seeding for PcgOneseq128XslRr64
This change is relevant for negative seed values.
* random: Document Mt19937::__construct()'s parameter value
* random: Add description for CryptoSafeEngine
* random: Add description for RandomError
* random: Add description for RandomException
* random: Improve phrasing for MT_RAND_PHP for Mt19937
Co-authored-by: George Peter Banyard <girgias@php.net>
* random: Explain the `$mode` parameter for Mt19937 construction with a list
Co-authored-by: George Peter Banyard <girgias@php.net>
* random: Fix Randomizer::__construct()'s default value
The parameter is nullable and the actual default value should rather be
considered `null`. `null` is then *internally* replaced with a new instance of
`Random\Engine\Secure`.
* random: Document Randomizer::__construct()'s parameters
* random: Document Randomizer::getBytes()' parameter and return value
The phrasing is adapted from and synced with `random_bytes()`.
* random: Fix classname references for CSPRNG failures
* random: Unify phrasing random_int parameter description
* random: Document Randomizer::getInt()'s parameter and return value
The phrasing is adapted from and synced with `random_int()`.
* random: Add random.engineErrors snippets
This explains that the Randomizer's methods will pass through any Throwables
thrown by the engine.
* random: Fix definition of Randomizer::$engine
* random: Improve random_int/getInt parameter descriptions
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
* random: Improve random_int return value description
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
* random: Fix link to Randomizer::$engine property
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
* random: Use `&null;` entity in Randomizer::__construct()
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
