Add descriptions

php · Nov 17, 2024 · 0fcc62a · 0fcc62a
1 parent a882a03
commit 0fcc62a
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 39 deletions.
diff --git a/reference/random/book.xml b/reference/random/book.xml
@@ -16,6 +16,7 @@
  &reference.random.reference;
 
  &reference.random.random.randomizer;
+ &reference.random.random.intervalboundary;
 
  &reference.random.random.engine;
  &reference.random.random.cryptosafeengine;

diff --git a/reference/random/random.intervalboundary.xml b/reference/random/random.intervalboundary.xml
@@ -1,73 +1,51 @@
 <?xml version="1.0" encoding="utf-8"?>
-<reference xmlns="http://docbook.org/ns/docbook" xml:id="enum.intervalboundary" role="enum">
- <title>IntervalBoundary</title>
- <titleabbrev>IntervalBoundary</titleabbrev>
+<reference xmlns="http://docbook.org/ns/docbook" xml:id="enum.random.intervalboundary" role="enum">
+ <title>Random\IntervalBoundary</title>
+ <titleabbrev>Random\IntervalBoundary</titleabbrev>
 
  <partintro>
-  <section xml:id="enum.intervalboundary.intro">
+  <section xml:id="enum.random.intervalboundary.intro">
    &reftitle.intro;
    <simpara>
-    Intro
+    The <enumname>Random\IntervalBoundary</enumname> cases determines if the
+    boundary values can be returned or not by
+    <methodname>Random\Randomizer::getFloat</methodname>.
    </simpara>
   </section>
 
-  <section xml:id="enum.intervalboundary.synopsis">
-   <!-- TODO New Reftitle entity -->
-   &reftitle.classsynopsis;
+  <section xml:id="enum.random.intervalboundary.synopsis">
+   &reftitle.enumsynopsis;
 
    <enumsynopsis>
-    <enumname>IntervalBoundary</enumname>
-    <!-- <modifier role="enum_backing_type">string|int</modifier> -->
-
+    <enumname>Random\IntervalBoundary</enumname>
+
     <enumitem>
      <enumidentifier>ClosedOpen</enumidentifier>
-     <!--
-     <enumvalue>
-      <literal>"string value"</literal>
-      <literal>25</literal>
-     </enumvalue>
-     -->
      <enumitemdescription>
-      Description of enum case.
+      The <parameter>min</parameter> value may be returned.
+      However, the <parameter>max</parameter> value will never be returned.
      </enumitemdescription>
     </enumitem>
 
     <enumitem>
      <enumidentifier>ClosedClosed</enumidentifier>
-     <!--
-     <enumvalue>
-      <literal>"string value"</literal>
-      <literal>25</literal>
-     </enumvalue>
-     -->
      <enumitemdescription>
-      Description of enum case.
+      Both the <parameter>min</parameter> and <parameter>max</parameter> value may be returned.
      </enumitemdescription>
     </enumitem>
 
     <enumitem>
      <enumidentifier>OpenClosed</enumidentifier>
-     <!--
-     <enumvalue>
-      <literal>"string value"</literal>
-      <literal>25</literal>
-     </enumvalue>
-     -->
      <enumitemdescription>
-      Description of enum case.
+      The <parameter>max</parameter> value may be returned.
+      However, the <parameter>min</parameter> value will never be returned.
      </enumitemdescription>
     </enumitem>
 
     <enumitem>
      <enumidentifier>OpenOpen</enumidentifier>
-     <!--
-     <enumvalue>
-      <literal>"string value"</literal>
-      <literal>25</literal>
-     </enumvalue>
-     -->
      <enumitemdescription>
-      Description of enum case.
+      Neither the <parameter>min</parameter> or <parameter>max</parameter> will ever be returned.
      </enumitemdescription>
     </enumitem>