From afb583c4c31ff2f5649bde60a834dfc656abd732 Mon Sep 17 00:00:00 2001
From: Anatol Belski <ab@php.net>
Date: Mon, 11 Sep 2017 20:26:09 +0000
Subject: [PATCH] Document Parle\RLexer

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343072 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/parle/book.xml                   |   1 +
 reference/parle/parle.rlexer.xml           |   3 +-
 reference/parle/parle/rlexer/push.xml      | 109 +++++++++++++++++++--
 reference/parle/parle/rlexer/pushstate.xml |   9 +-
 reference/parle/parle/rlexer/state.xml     |   7 +-
 5 files changed, 109 insertions(+), 20 deletions(-)

diff --git a/reference/parle/book.xml b/reference/parle/book.xml
index 68fcf6291a..6740600ec9 100644
--- a/reference/parle/book.xml
+++ b/reference/parle/book.xml
@@ -19,6 +19,7 @@
  &reference.parle.pattern.matching;
  &reference.parle.examples;
  &reference.parle.parle.lexer;
+ &reference.parle.parle.rlexer;
  &reference.parle.parle.token;
  &reference.parle.parle.parser;
  &reference.parle.parle.errorinfo;
diff --git a/reference/parle/parle.rlexer.xml b/reference/parle/parle.rlexer.xml
index 05ce82c0bf..52990aac75 100644
--- a/reference/parle/parle.rlexer.xml
+++ b/reference/parle/parle.rlexer.xml
@@ -126,7 +126,8 @@
 
  </partintro>
 
- &reference.parle.entities.parle-rlexer;
+ <!--&reference.parle.entities.parle-rlexer;-->
+ &reference.parle.parle.entities.rlexer;
 
 </phpdoc:classref>
 
diff --git a/reference/parle/parle/rlexer/push.xml b/reference/parle/parle/rlexer/push.xml
index 8ef95b0921..1a96fbd386 100644
--- a/reference/parle/parle/rlexer/push.xml
+++ b/reference/parle/parle/rlexer/push.xml
@@ -4,32 +4,125 @@
 <refentry xml:id="parle-rlexer.push" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Parle\RLexer::push</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Add a lexer rule</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Parle\RLexer::push</methodname>
-   <void />
+   <modifier>public</modifier> <type>void</type><methodname>Parle\Lexer::push</methodname>
+   <methodparam><type>string</type><parameter>regex</parameter></methodparam>
+   <methodparam><type>integer</type><parameter>id</parameter></methodparam>
+   <!--<methodparam choice="opt"><type>integer</type><parameter>userId</parameter></methodparam>-->
+  </methodsynopsis>
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>Parle\Lexer::push</methodname>
+   <methodparam><type>string</type><parameter>regexStart</parameter></methodparam>
+   <methodparam><type>string</type><parameter>regexEnd</parameter></methodparam>
+   <methodparam><type>integer</type><parameter>id</parameter></methodparam>
+   <!--<methodparam choice="opt"><type>integer</type><parameter>userId</parameter></methodparam>-->
+  </methodsynopsis>
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>Parle\Lexer::push</methodname>
+   <methodparam><type>string</type><parameter>state</parameter></methodparam>
+   <methodparam><type>string</type><parameter>regex</parameter></methodparam>
+   <methodparam><type>integer</type><parameter>id</parameter></methodparam>
+   <methodparam><type>string</type><parameter>newState</parameter></methodparam>
+   <!--<methodparam choice="opt"><type>integer</type><parameter>userId</parameter></methodparam>-->
+  </methodsynopsis>
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>Parle\Lexer::push</methodname>
+   <methodparam><type>string</type><parameter>state</parameter></methodparam>
+   <methodparam><type>string</type><parameter>regexStart</parameter></methodparam>
+   <methodparam><type>string</type><parameter>regexEnd</parameter></methodparam>
+   <methodparam><type>integer</type><parameter>id</parameter></methodparam>
+   <methodparam><type>string</type><parameter>newState</parameter></methodparam>
+   <!--<methodparam choice="opt"><type>integer</type><parameter>userId</parameter></methodparam>-->
+  </methodsynopsis>
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>Parle\Lexer::push</methodname>
+   <methodparam><type>string</type><parameter>state</parameter></methodparam>
+   <methodparam><type>string</type><parameter>regex</parameter></methodparam>
+   <methodparam><type>string</type><parameter>newState</parameter></methodparam>
+  </methodsynopsis>
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>Parle\Lexer::push</methodname>
+   <methodparam><type>string</type><parameter>state</parameter></methodparam>
+   <methodparam><type>string</type><parameter>regexStart</parameter></methodparam>
+   <methodparam><type>string</type><parameter>regexEnd</parameter></methodparam>
+   <methodparam><type>string</type><parameter>newState</parameter></methodparam>
   </methodsynopsis>
   <para>
 
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
   &reftitle.parameters;
-  &no.function.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>regex</parameter></term>
+    <listitem>
+     <para>
+      Regular expression used for token matching.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>regexStart</parameter></term>
+    <listitem>
+     <para>
+      Regular expression used to match the token start.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>regexEnd</parameter></term>
+    <listitem>
+     <para>
+      Regular expression used to match the token end.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>id</parameter></term>
+    <listitem>
+     <para>
+      Auto assigned token id.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>state</parameter></term>
+    <listitem>
+     <para>
+      State name.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>newState</parameter></term>
+    <listitem>
+     <para>
+      New state name, after the rule was applied.
+     </para>
+    </listitem>
+   </varlistentry>
+   <!--<varlistentry>
+    <term><parameter>userId</parameter></term>
+    <listitem>
+     <para>
+      User supplied token id.
+     </para>
+    </listitem>
+   </varlistentry>-->
+  </variablelist>
  </refsect1>
 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+   &return.void; 
   </para>
  </refsect1>
 
diff --git a/reference/parle/parle/rlexer/pushstate.xml b/reference/parle/parle/rlexer/pushstate.xml
index 202a403263..6ade4b4725 100644
--- a/reference/parle/parle/rlexer/pushstate.xml
+++ b/reference/parle/parle/rlexer/pushstate.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="parle-rlexer.pushstate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Parle\RLexer::pushState</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Push a new start state</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -14,11 +14,8 @@
    <methodparam><type>string</type><parameter>state</parameter></methodparam>
   </methodsynopsis>
   <para>
-
+   A lexer can have more than one state machine. This allows you to lex different tokens depending on context, thus allowing simple parsing to take place. To allow this, a 'start state' must be specified additionally at the beginning of the <methodname>Parle\RLexer::push</methodname> call and an 'exit state' at the end. If '*' is used as start state, then the rule is applied to all lexer states. If '.' is specified as the exit state, then the lexer state is unchanged when that rule matches.
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -28,7 +25,7 @@
     <term><parameter>state</parameter></term>
     <listitem>
      <para>
-      
+      Name of the state.
      </para>
     </listitem>
    </varlistentry>
diff --git a/reference/parle/parle/rlexer/state.xml b/reference/parle/parle/rlexer/state.xml
index a6f9934b8f..4cac1a030b 100644
--- a/reference/parle/parle/rlexer/state.xml
+++ b/reference/parle/parle/rlexer/state.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="parle-rlexer.state" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Parle\RLexer::state</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Get current lexer state</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 &integer;.  
   </para>
  </refsect1>