anna
/
ocarina
1
0
Fork 0
Code Issues 7 Pull Requests Releases Wiki Activity

random: Add doxygen information 

I updated the Doxyfile to extract static inline functions.

Signed-off-by: Anna Schumaker <Anna@OcarinaProject.net>
This commit is contained in:
Anna Schumaker 2014-09-13 09:56:54 -04:00
parent 86b15743a1
commit ad48ac7d16
3 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doxyfile
View File

@ -427,7 +427,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = NO
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO

3
core/random.cpp
View File

@ -1,4 +1,5 @@
/*
/**
* @file
* Copyright 2014 (c) Anna Schumaker
*/
#ifdef CONFIG_TEST

16
include/core/random.h
View File

@ -1,4 +1,5 @@
/*
/**
* @file
* Copyright 2014 (c) Anna Schumaker
*/
#ifndef OCARINA_CORE_RANDOM_H
@ -18,12 +19,23 @@ static inline unsigned int _pick_random() { return rand(); }
#endif /* CONFIG_TEST */
/**
* Seed the random number generator.
*
* @param n Value used to initialize the RNG
*/
static inline void random_seed(unsigned int n)
{
_seed_random(n);
}
/**
* Get a random number in the specified range.
*
* @param min Minimum value that will be returned.
* @param max Maximum value that will be returned.
* @return A random value where min <= value <= max.
*/
static inline unsigned int random(unsigned int min, unsigned int max)
{
if (min >= max)