|
1 | 1 | <?xml version="1.0" encoding="utf-8"?> |
2 | | -<reference xmlns="http://docbook.org/ns/docbook" xml:id="enum.intervalboundary" role="enum"> |
3 | | - <title>IntervalBoundary</title> |
4 | | - <titleabbrev>IntervalBoundary</titleabbrev> |
| 2 | +<reference xmlns="http://docbook.org/ns/docbook" xml:id="enum.random.intervalboundary" role="enum"> |
| 3 | + <title>Random\IntervalBoundary</title> |
| 4 | + <titleabbrev>Random\IntervalBoundary</titleabbrev> |
5 | 5 |
|
6 | 6 | <partintro> |
7 | | - <section xml:id="enum.intervalboundary.intro"> |
| 7 | + <section xml:id="enum.random.intervalboundary.intro"> |
8 | 8 | &reftitle.intro; |
9 | 9 | <simpara> |
10 | | - Intro |
| 10 | + The <enumname>Random\IntervalBoundary</enumname> cases determines if the |
| 11 | + boundary values can be returned or not by |
| 12 | + <methodname>Random\Randomizer::getFloat</methodname>. |
11 | 13 | </simpara> |
12 | 14 | </section> |
13 | 15 |
|
14 | | - <section xml:id="enum.intervalboundary.synopsis"> |
15 | | - <!-- TODO New Reftitle entity --> |
16 | | - &reftitle.classsynopsis; |
| 16 | + <section xml:id="enum.random.intervalboundary.synopsis"> |
| 17 | + &reftitle.enumsynopsis; |
17 | 18 |
|
18 | 19 | <enumsynopsis> |
19 | | - <enumname>IntervalBoundary</enumname> |
20 | | - <!-- <modifier role="enum_backing_type">string|int</modifier> --> |
21 | | - |
| 20 | + <enumname>Random\IntervalBoundary</enumname> |
| 21 | + |
22 | 22 | <enumitem> |
23 | 23 | <enumidentifier>ClosedOpen</enumidentifier> |
24 | | - <!-- |
25 | | - <enumvalue> |
26 | | - <literal>"string value"</literal> |
27 | | - <literal>25</literal> |
28 | | - </enumvalue> |
29 | | - --> |
30 | 24 | <enumitemdescription> |
31 | | - Description of enum case. |
| 25 | + The <parameter>min</parameter> value may be returned. |
| 26 | + However, the <parameter>max</parameter> value will never be returned. |
32 | 27 | </enumitemdescription> |
33 | 28 | </enumitem> |
34 | 29 |
|
35 | 30 | <enumitem> |
36 | 31 | <enumidentifier>ClosedClosed</enumidentifier> |
37 | | - <!-- |
38 | | - <enumvalue> |
39 | | - <literal>"string value"</literal> |
40 | | - <literal>25</literal> |
41 | | - </enumvalue> |
42 | | - --> |
43 | 32 | <enumitemdescription> |
44 | | - Description of enum case. |
| 33 | + Both the <parameter>min</parameter> and <parameter>max</parameter> value may be returned. |
45 | 34 | </enumitemdescription> |
46 | 35 | </enumitem> |
47 | 36 |
|
48 | 37 | <enumitem> |
49 | 38 | <enumidentifier>OpenClosed</enumidentifier> |
50 | | - <!-- |
51 | | - <enumvalue> |
52 | | - <literal>"string value"</literal> |
53 | | - <literal>25</literal> |
54 | | - </enumvalue> |
55 | | - --> |
56 | 39 | <enumitemdescription> |
57 | | - Description of enum case. |
| 40 | + The <parameter>max</parameter> value may be returned. |
| 41 | + However, the <parameter>min</parameter> value will never be returned. |
58 | 42 | </enumitemdescription> |
59 | 43 | </enumitem> |
60 | 44 |
|
61 | 45 | <enumitem> |
62 | 46 | <enumidentifier>OpenOpen</enumidentifier> |
63 | | - <!-- |
64 | | - <enumvalue> |
65 | | - <literal>"string value"</literal> |
66 | | - <literal>25</literal> |
67 | | - </enumvalue> |
68 | | - --> |
69 | 47 | <enumitemdescription> |
70 | | - Description of enum case. |
| 48 | + Neither the <parameter>min</parameter> or <parameter>max</parameter> will ever be returned. |
71 | 49 | </enumitemdescription> |
72 | 50 | </enumitem> |
73 | 51 |
|
|
0 commit comments