[FFmpeg-cvslog] random_seed: more elaborate doxy.

[Michael Niedermayer]

ffmpeg | branch: master | Michael Niedermayer <michaelni at gmx.at> | Tue Jun 28 04:23:20 2011 +0200| [94e59cb84b0fbc016333c22685cdc4afeabbdf08] | committer: Michael Niedermayer

random_seed: more elaborate doxy.

Signed-off-by: Michael Niedermayer <michaelni at gmx.at>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=94e59cb84b0fbc016333c22685cdc4afeabbdf08
---

 libavutil/random_seed.h |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/libavutil/random_seed.h b/libavutil/random_seed.h
index 7f75063..bb95787 100644
--- a/libavutil/random_seed.h
+++ b/libavutil/random_seed.h
@@ -25,6 +25,10 @@
 
 /**
  * Get a seed to use in conjunction with random functions.
+ * This function tries to provide a good seed at a best effort bases.
+ * Its possible to call this function multiple times if more bits are needed.
+ * It can be quite slow, which is why it should only be used as seed for a faster
+ * PRNG. The quality of the seed depends on the platform.
  */
 uint32_t av_get_random_seed(void);