From 17da9d0d5e08ef313055cf799fec7ee856fde1d4 Mon Sep 17 00:00:00 2001
From: Raimo Niskanen <raimo@erlang.org>
Date: Mon, 25 Feb 2019 12:10:40 +0100
Subject: Create a gen_statem type for enter_loop options

---
 lib/stdlib/doc/src/gen_statem.xml | 63 ++++++++++++++++++++-------------------
 lib/stdlib/doc/src/sys.xml        |  5 +++-
 2 files changed, 36 insertions(+), 32 deletions(-)

(limited to 'lib/stdlib/doc/src')

diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml
index dfecd235c9..0a7619baf5 100644
--- a/lib/stdlib/doc/src/gen_statem.xml
+++ b/lib/stdlib/doc/src/gen_statem.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>2016</year><year>2018</year>
+      <year>2016</year><year>2019</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -513,36 +513,6 @@ handle_event(_, _, State, Data) ->
 	</taglist>
       </desc>
     </datatype>
-    <datatype>
-      <name name="debug_opt"/>
-      <desc>
-	<p>
-	  Debug option that can be used when starting
-	  a <c>gen_statem</c> server through,
-	  <seealso marker="#enter_loop/4"><c>enter_loop/4-6</c></seealso>.
-	</p>
-	<p>
-	  For every entry in <c><anno>Dbgs</anno></c>,
-	  the corresponding function in
-	  <seealso marker="sys"><c>sys</c></seealso> is called.
-	</p>
-      </desc>
-    </datatype>
-    <datatype>
-      <name name="hibernate_after_opt"/>
-      <desc>
-	<p>
-          hibernate_after option that can be used when starting
-	  a <c>gen_statem</c> server through,
-	  <seealso marker="#enter_loop/4"><c>enter_loop/4-6</c></seealso>.
-	</p>
-    <p>If option<seealso marker="#type-hibernate_after_opt"><c>{hibernate_after,HibernateAfterTimeout}</c></seealso> is present, the <c>gen_statem</c>
-        process awaits any message for <c>HibernateAfterTimeout</c> milliseconds and
-        if no message is received, the process goes into hibernation automatically
-        (by calling <seealso marker="proc_lib#hibernate/3"><c>proc_lib:hibernate/3</c></seealso>).
-    </p>
-      </desc>
-    </datatype>
     <datatype>
       <name name="start_opt"/>
       <desc>
@@ -562,6 +532,37 @@ handle_event(_, _, State, Data) ->
 	</p>
       </desc>
     </datatype>
+    <datatype>
+      <name name="enter_loop_opt"/>
+      <desc>
+	<p>
+	  Options that can be used when starting
+	  a <c>gen_statem</c> server through,
+	  <seealso marker="#enter_loop/4"><c>enter_loop/4-6</c></seealso>.
+	</p>
+	<taglist>
+	  <tag><c>hibernate_after</c></tag>
+	  <item>
+	    <p>
+	      <c>HibernateAfterTimeout</c>
+	      specifies that the <c>gen_statem</c> process awaits
+	      any message for <c>HibernateAfterTimeout</c> milliseconds and
+              if no message is received, the process goes into hibernation
+	      automatically (by calling
+	      <seealso marker="proc_lib#hibernate/3"><c>proc_lib:hibernate/3</c></seealso>).
+	    </p>
+	  </item>
+	  <tag><c>debug</c></tag>
+	  <item>
+	    <p>
+	      For every entry in <c><anno>Dbgs</anno></c>,
+	      the corresponding function in
+	      <seealso marker="sys"><c>sys</c></seealso> is called.
+	    </p>
+	  </item>
+	</taglist>
+      </desc>
+    </datatype>
     <datatype>
       <name name="from"/>
       <desc>
diff --git a/lib/stdlib/doc/src/sys.xml b/lib/stdlib/doc/src/sys.xml
index 9fe816e33a..bf48ae0723 100644
--- a/lib/stdlib/doc/src/sys.xml
+++ b/lib/stdlib/doc/src/sys.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1996</year><year>2018</year>
+      <year>1996</year><year>2019</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -122,6 +122,9 @@
     <datatype>
       <name name="dbg_fun"/>
     </datatype>
+    <datatype>
+      <name name="debug_option"/>
+    </datatype>
     <datatype>
       <name name="format_fun"/>
     </datatype>
-- 
cgit v1.2.3