From 178e89af371196e54f8808f76831321ab859c6fb Mon Sep 17 00:00:00 2001
From: Xinchen Hui <laruence@php.net>
Date: Wed, 31 Aug 2011 03:22:36 +0000
Subject: [PATCH] Add new docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@315843 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../{register.xml => registerCallback.xml}    |   2 +-
 reference/lua/luaclosure.xml                  |  67 +++++++++++
 reference/lua/luaclosure/clone.xml            |  58 +++++++++
 reference/lua/luaclosure/construct.xml        |  58 +++++++++
 reference/lua/luaclosure/destruct.xml         |  58 +++++++++
 reference/lua/luaclosure/invoke.xml           |  76 ++++++++++++
 reference/lua/luaexception.xml                | 112 ++++++++++++++++++
 reference/lua/versions.xml                    |  30 +++--
 8 files changed, 452 insertions(+), 9 deletions(-)
 rename reference/lua/functions/{register.xml => registerCallback.xml} (97%)
 create mode 100644 reference/lua/luaclosure.xml
 create mode 100644 reference/lua/luaclosure/clone.xml
 create mode 100644 reference/lua/luaclosure/construct.xml
 create mode 100644 reference/lua/luaclosure/destruct.xml
 create mode 100644 reference/lua/luaclosure/invoke.xml
 create mode 100644 reference/lua/luaexception.xml

diff --git a/reference/lua/functions/register.xml b/reference/lua/functions/registerCallback.xml
similarity index 97%
rename from reference/lua/functions/register.xml
rename to reference/lua/functions/registerCallback.xml
index dd466a5e32..01d95bc47b 100644
--- a/reference/lua/functions/register.xml
+++ b/reference/lua/functions/registerCallback.xml
@@ -3,7 +3,7 @@
 
 <refentry xml:id="lua.register" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
-  <refname>Lua::register</refname>
+  <refname>Lua::registerCallback</refname>
   <refpurpose>Register a PHP function to Lua</refpurpose>
  </refnamediv>
 
diff --git a/reference/lua/luaclosure.xml b/reference/lua/luaclosure.xml
new file mode 100644
index 0000000000..d24ae85577
--- /dev/null
+++ b/reference/lua/luaclosure.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<phpdoc:classref xml:id="class.luaclosure" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The LuaClosure class</title>
+ <titleabbrev>LuaClosure</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ LuaClosure intro -->
+  <section xml:id="luaclosure.intro">
+   &reftitle.intro;
+   <para>
+
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="luaclosure.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>LuaClosure</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>LuaClosure</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+    
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.luaclosure')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.lua.entities.luaclosure;
+
+</phpdoc:classref>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/lua/luaclosure/clone.xml b/reference/lua/luaclosure/clone.xml
new file mode 100644
index 0000000000..fe8ee4c803
--- /dev/null
+++ b/reference/lua/luaclosure/clone.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="luaclosure.clone" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>LuaClosure::__clone</refname>
+  <refpurpose>The __clone purpose</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>private</modifier> <type>void</type><methodname>LuaClosure::__clone</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/lua/luaclosure/construct.xml b/reference/lua/luaclosure/construct.xml
new file mode 100644
index 0000000000..8b7f7eae6c
--- /dev/null
+++ b/reference/lua/luaclosure/construct.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="luaclosure.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>LuaClosure::__construct</refname>
+  <refpurpose>The __construct purpose</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <methodname>LuaClosure::__construct</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/lua/luaclosure/destruct.xml b/reference/lua/luaclosure/destruct.xml
new file mode 100644
index 0000000000..da0e38d9e3
--- /dev/null
+++ b/reference/lua/luaclosure/destruct.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="luaclosure.destruct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>LuaClosure::__destruct</refname>
+  <refpurpose>The __destruct purpose</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>LuaClosure::__destruct</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/lua/luaclosure/invoke.xml b/reference/lua/luaclosure/invoke.xml
new file mode 100644
index 0000000000..6e29670550
--- /dev/null
+++ b/reference/lua/luaclosure/invoke.xml
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="luaclosure.invoke" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>LuaClosure::__invoke</refname>
+  <refpurpose>The __invoke purpose</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>LuaClosure::__invoke</methodname>
+   <methodparam><type>mixed</type><parameter>arg</parameter></methodparam>
+   <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>arg</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>...</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/lua/luaexception.xml b/reference/lua/luaexception.xml
new file mode 100644
index 0000000000..af44e80e7e
--- /dev/null
+++ b/reference/lua/luaexception.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<phpdoc:classref xml:id="class.luaexception" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The LuaException class</title>
+ <titleabbrev>LuaException</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ LuaException intro -->
+  <section xml:id="luaexception.intro">
+   &reftitle.intro;
+   <para>
+
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="luaexception.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>LuaException</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>LuaException</classname>
+     </ooclass>
+     
+     <ooclass>
+      <modifier>extends</modifier>
+      <classname>Exception</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
+
+    
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.luaexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+    
+    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+  
+<!-- {{{ LuaException properties -->
+  <section xml:id="luaexception.props">
+   &reftitle.properties;
+   <variablelist>
+    <varlistentry xml:id="luaexception.props.message">
+     <term><varname>message</varname></term>
+     <listitem>
+      <para></para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="luaexception.props.code">
+     <term><varname>code</varname></term>
+     <listitem>
+      <para></para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="luaexception.props.file">
+     <term><varname>file</varname></term>
+     <listitem>
+      <para></para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="luaexception.props.line">
+     <term><varname>line</varname></term>
+     <listitem>
+      <para></para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </section>
+<!-- }}} -->
+
+
+ </partintro>
+
+ &reference.lua.entities.luaexception;
+
+</phpdoc:classref>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/lua/versions.xml b/reference/lua/versions.xml
index 00696f7866..dc51d5f739 100644
--- a/reference/lua/versions.xml
+++ b/reference/lua/versions.xml
@@ -6,14 +6,28 @@
 
 <versions>
   <!-- Methods -->
- <function name='lua::__construct' from='PECL lua &gt;= Unknown'/>
- <function name='lua::__call' from='PECL lua &gt;= Unknown'/>
- <function name='lua::eval' from='PECL lua &gt;= Unknown'/>
- <function name='lua::include' from='PECL lua &gt;= Unknown'/>
- <function name='lua::call' from='PECL lua &gt;= Unknown'/>
- <function name='lua::assign' from='PECL lua &gt;= Unknown'/>
- <function name='lua::register' from='PECL lua &gt;= Unknown'/>
- <function name='lua::getversion' from='PECL lua &gt;= Unknown'/>
+ <function name='lua::__construct' from='PECL lua &gt;=0.9.0'/>
+ <function name='lua::__call' from='PECL lua &gt;=0.9.0'/>
+ <function name='lua::eval' from='PECL lua &gt;=0.9.0'/>
+ <function name='lua::include' from='PECL lua &gt;=0.9.0'/>
+ <function name='lua::call' from='PECL lua &gt;=0.9.0'/>
+ <function name='lua::assign' from='PECL lua &gt;=0.9.0'/>
+ <function name='lua::register' from='PECL lua &gt;=0.9.0'/>
+ <function name='lua::getversion' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaclosure::__construct' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaclosure::__destruct' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaclosure::__clone' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaclosure::invoke' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaclosure::__invoke' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaexception::__clone' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaexception::__construct' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaexception::getmessage' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaexception::getcode' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaexception::getfile' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaexception::getline' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaexception::gettrace' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaexception::gettraceasstring' from='PECL lua &gt;=0.9.0'/>
+ <function name='luaexception::__tostring' from='PECL lua &gt;=0.9.0'/>
 </versions>
 
 <!-- Keep this comment at the end of the file