Doc: add warning against bulk random data creation to QRandomGenerator

The full documentation explains it well but a more prominent warning
will help avoid the wrong use of that class and encourage user to read
further the documentation.

Change-Id: I3178749f2b1b0350040f81eef253fd85c7ba0a5f
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
This commit is contained in:
Samuel Gaist 2017-06-14 09:11:02 +02:00 committed by Frederik Gladhorn
parent 60bfd6a214
commit 82fbf97903

View File

@ -467,9 +467,12 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd)
Additionally, it provides a floating-point function getReal() that returns Additionally, it provides a floating-point function getReal() that returns
a number in the range [0, 1) (that is, inclusive of zero and exclusive of a number in the range [0, 1) (that is, inclusive of zero and exclusive of
1). There's also a set of convenience functions that facilitate obtaininga 1). There's also a set of convenience functions that facilitate obtaining a
random number in a bounded, integral range. random number in a bounded, integral range.
\warning This class is not suitable for bulk data creation. See below for the
technical reasons.
\section1 Frequency and entropy exhaustion \section1 Frequency and entropy exhaustion
QRandomGenerator does not need to be seeded and instead uses operating system QRandomGenerator does not need to be seeded and instead uses operating system