Skip to content

Commit 5edab25

Browse files
committed
Add descriptions
1 parent bce294d commit 5edab25

File tree

3 files changed

+19
-39
lines changed

3 files changed

+19
-39
lines changed

language-defs.ent

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ supplemental files to mark section titles -->
8686
<!ENTITY reftitle.changelog '<title xmlns="http://docbook.org/ns/docbook">&Changelog;</title>'>
8787
<!ENTITY reftitle.classes '<title xmlns="http://docbook.org/ns/docbook">Predefined Classes</title>'>
8888
<!ENTITY reftitle.classsynopsis '<title xmlns="http://docbook.org/ns/docbook">Class synopsis</title>'>
89+
<!ENTITY reftitle.enumsynopsis '<title xmlns="http://docbook.org/ns/docbook">Enum synopsis</title>'>
8990
<!ENTITY reftitle.constants '<title xmlns="http://docbook.org/ns/docbook">Predefined Constants</title>'>
9091
<!ENTITY reftitle.constructor '<title xmlns="http://docbook.org/ns/docbook">Constructor</title>'>
9192
<!ENTITY reftitle.description '<title xmlns="http://docbook.org/ns/docbook">Description</title>'>

reference/random/book.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
&reference.random.reference;
1717

1818
&reference.random.random.randomizer;
19+
&reference.random.random.intervalboundary;
1920

2021
&reference.random.random.engine;
2122
&reference.random.random.cryptosafeengine;

reference/random/random.intervalboundary.xml

Lines changed: 17 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,51 @@
11
<?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>
55

66
<partintro>
7-
<section xml:id="enum.intervalboundary.intro">
7+
<section xml:id="enum.random.intervalboundary.intro">
88
&reftitle.intro;
99
<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>.
1113
</simpara>
1214
</section>
1315

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;
1718

1819
<enumsynopsis>
19-
<enumname>IntervalBoundary</enumname>
20-
<!-- <modifier role="enum_backing_type">string|int</modifier> -->
21-
20+
<enumname>Random\IntervalBoundary</enumname>
21+
2222
<enumitem>
2323
<enumidentifier>ClosedOpen</enumidentifier>
24-
<!--
25-
<enumvalue>
26-
<literal>"string value"</literal>
27-
<literal>25</literal>
28-
</enumvalue>
29-
-->
3024
<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.
3227
</enumitemdescription>
3328
</enumitem>
3429

3530
<enumitem>
3631
<enumidentifier>ClosedClosed</enumidentifier>
37-
<!--
38-
<enumvalue>
39-
<literal>"string value"</literal>
40-
<literal>25</literal>
41-
</enumvalue>
42-
-->
4332
<enumitemdescription>
44-
Description of enum case.
33+
Both the <parameter>min</parameter> and <parameter>max</parameter> value may be returned.
4534
</enumitemdescription>
4635
</enumitem>
4736

4837
<enumitem>
4938
<enumidentifier>OpenClosed</enumidentifier>
50-
<!--
51-
<enumvalue>
52-
<literal>"string value"</literal>
53-
<literal>25</literal>
54-
</enumvalue>
55-
-->
5639
<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.
5842
</enumitemdescription>
5943
</enumitem>
6044

6145
<enumitem>
6246
<enumidentifier>OpenOpen</enumidentifier>
63-
<!--
64-
<enumvalue>
65-
<literal>"string value"</literal>
66-
<literal>25</literal>
67-
</enumvalue>
68-
-->
6947
<enumitemdescription>
70-
Description of enum case.
48+
Neither the <parameter>min</parameter> or <parameter>max</parameter> will ever be returned.
7149
</enumitemdescription>
7250
</enumitem>
7351

0 commit comments

Comments
 (0)