Skip to content

Commit 124c866

Browse files
committed
Added header docs for famous doubles and decimal number generators.
1 parent 431f4ee commit 124c866

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

Fox/Public/Generators/FOXNumericGenerators.h

+25-3
Original file line numberDiff line numberDiff line change
@@ -185,14 +185,36 @@ FOX_EXPORT id<FOXGenerator> FOXFamousStrictPositiveInteger(void);
185185
FOX_EXPORT id<FOXGenerator> FOXFamousNonZeroInteger(void);
186186

187187
/*! Creates a generator that produces random floats (boxed as NSNumbers) with
188-
* an increased probability of choosing extreme values (NAN, INFINITY,
189-
* -INFINITY, -0). Shrinks towards zero. Floats generated conform to
188+
* an increased probability of choosing extreme values (NaN, INFINITY,
189+
* -INFINITY, -0, MAX, MIN). Shrinks towards zero. Doubles generated conform to
190190
* IEEE standard.
191191
*
192-
* The size hint dictates the min & max values that can be generated.
192+
* The size hint dictates the min & max values that can be generated with the
193+
* exception of extreme values.
193194
*
194195
* @returns a generator that produces floats (boxed in NSNumbers).
195196
*/
196197
FOX_EXPORT id<FOXGenerator> FOXFamousFloat(void);
198+
199+
/*! Creates a generator that produces random doubles (boxed as NSNumbers) with
200+
* an increased probability of choosing extreme values (NaN, INFINITY,
201+
* -INFINITY, -0, MIN, MAX). Shrinks towards zero. Doubles generated conform to
202+
* IEEE standard.
203+
*
204+
* The size hint dictates the min & max values that can be generated with the
205+
* exception of extreme values.
206+
*
207+
* @returns a generator that produces doubles (boxed in NSNumbers).
208+
*/
197209
FOX_EXPORT id<FOXGenerator> FOXFamousDouble(void);
210+
211+
/*! Creates a generator that produces random decimal numbers with an increased
212+
* probability of choosing extreme values (NaN, MIN, MAX).
213+
* Shrinks towards [NSDecimalNumber zero].
214+
*
215+
* The size hint dictates the min & max values that can be generated with the
216+
* exception of extreme values.
217+
*
218+
* @returns a generator that produces NSDecimalNumbers.
219+
*/
198220
FOX_EXPORT id<FOXGenerator> FOXFamousDecimalNumber(void);

0 commit comments

Comments
 (0)