From 4459fb54c54211cb43795ab662aa31d04e7e9ed4 Mon Sep 17 00:00:00 2001
From: Anatol Belski <ab@php.net>
Date: Sun, 10 Sep 2017 21:12:01 +0000
Subject: [PATCH] Document Parle\Stack

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343061 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/parle/book.xml              |  1 +
 reference/parle/parle.stack.xml       |  3 ++-
 reference/parle/parle/stack/empty.xml |  9 +++------
 reference/parle/parle/stack/pop.xml   |  7 ++-----
 reference/parle/parle/stack/push.xml  | 11 ++++-------
 reference/parle/parle/stack/size.xml  |  7 ++-----
 reference/parle/parle/stack/top.xml   | 13 +++++--------
 7 files changed, 19 insertions(+), 32 deletions(-)

diff --git a/reference/parle/book.xml b/reference/parle/book.xml
index 61dd17f9a2..68fcf6291a 100644
--- a/reference/parle/book.xml
+++ b/reference/parle/book.xml
@@ -22,6 +22,7 @@
  &reference.parle.parle.token;
  &reference.parle.parle.parser;
  &reference.parle.parle.errorinfo;
+ &reference.parle.parle.stack;
  &reference.parle.parle.lexerexception;
  &reference.parle.parle.parserexception;
 
diff --git a/reference/parle/parle.stack.xml b/reference/parle/parle.stack.xml
index 05e40919c0..3c79e46aef 100644
--- a/reference/parle/parle.stack.xml
+++ b/reference/parle/parle.stack.xml
@@ -41,7 +41,8 @@
 
  </partintro>
 
- &reference.parle.entities.parle-stack;
+ <!--&reference.parle.entities.parle-stack;-->
+ &reference.parle.parle.entities.stack;
 
 </phpdoc:classref>
 
diff --git a/reference/parle/parle/stack/empty.xml b/reference/parle/parle/stack/empty.xml
index 9ef0c8eb20..45cf4fe9be 100644
--- a/reference/parle/parle/stack/empty.xml
+++ b/reference/parle/parle/stack/empty.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="parle-stack.empty" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Parle\Stack::empty</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Check whether the stack is empty</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -14,11 +14,8 @@
    <void />
   </methodsynopsis>
   <para>
-
+   
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +26,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+   Returns &boolean;.
   </para>
  </refsect1>
 
diff --git a/reference/parle/parle/stack/pop.xml b/reference/parle/parle/stack/pop.xml
index 19f145095e..7b4c629129 100644
--- a/reference/parle/parle/stack/pop.xml
+++ b/reference/parle/parle/stack/pop.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="parle-stack.pop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Parle\Stack::pop</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Pop an item from the stack</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -16,9 +16,6 @@
   <para>
 
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +26,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+   &return.void; 
   </para>
  </refsect1>
 
diff --git a/reference/parle/parle/stack/push.xml b/reference/parle/parle/stack/push.xml
index 361bef8fd7..1292b16413 100644
--- a/reference/parle/parle/stack/push.xml
+++ b/reference/parle/parle/stack/push.xml
@@ -4,21 +4,18 @@
 <refentry xml:id="parle-stack.push" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Parle\Stack::push</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Push an item into the stack</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>void</type><methodname>Parle\Stack::push</methodname>
-   <methodparam><type>string</type><parameter>item</parameter></methodparam>
+   <methodparam><type>mixed</type><parameter>item</parameter></methodparam>
   </methodsynopsis>
   <para>
 
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -28,7 +25,7 @@
     <term><parameter>item</parameter></term>
     <listitem>
      <para>
-      
+      Variable to be pushed.
      </para>
     </listitem>
    </varlistentry>
@@ -38,7 +35,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+   &return.void;  
   </para>
  </refsect1>
 
diff --git a/reference/parle/parle/stack/size.xml b/reference/parle/parle/stack/size.xml
index 9df678afd1..463f9b2306 100644
--- a/reference/parle/parle/stack/size.xml
+++ b/reference/parle/parle/stack/size.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="parle-stack.size" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Parle\Stack::size</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Retrieve the stack size</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -16,9 +16,6 @@
   <para>
 
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +26,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+   Returns &integer; representing the item number in the stack. 
   </para>
  </refsect1>
 
diff --git a/reference/parle/parle/stack/top.xml b/reference/parle/parle/stack/top.xml
index 6ec3b8702d..c4900f9063 100644
--- a/reference/parle/parle/stack/top.xml
+++ b/reference/parle/parle/stack/top.xml
@@ -4,21 +4,18 @@
 <refentry xml:id="parle-stack.top" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Parle\Stack::top</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Retrieve or replace the stack top</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Parle\Stack::top</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>new_top</parameter></methodparam>
+   <modifier>public</modifier> <type>mixed</type><methodname>Parle\Stack::top</methodname>
+   <methodparam choice="opt"><type>mixed</type><parameter>new_top</parameter></methodparam>
   </methodsynopsis>
   <para>
 
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -28,7 +25,7 @@
     <term><parameter>new_top</parameter></term>
     <listitem>
      <para>
-      
+      The item which is to replace the stack top.
      </para>
     </listitem>
    </varlistentry>
@@ -38,7 +35,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+   If no argiments are passed, returns the current top. Otherwise, if a replacement is given, returns &null;.
   </para>
  </refsect1>