Document Parle\Stack

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343061 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Anatol Belski 2017-09-10 21:12:01 +00:00
parent 86756e7cce
commit 4459fb54c5
7 changed files with 19 additions and 32 deletions

View file

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

View file

@ -41,7 +41,8 @@
</partintro>
&reference.parle.entities.parle-stack;
<!--&reference.parle.entities.parle-stack;-->
&reference.parle.parle.entities.stack;
</phpdoc:classref>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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>