svn: /phpdoc/en/trunk/reference/v8js/v8js/ construct.xml executestring.xml getextensions.xml getpendingexception.xml registerextension.xml
| From: | Jani Taskinen | Date: | Fri, 31 Dec 2010 13:51:35 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/v8js/v8js/ construct.xml executestring.xml getextensions.xml getpendingexception.xml registerextension.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7594@lists.php.net to get a copy of this message | ||
jani Fri, 31 Dec 2010 13:51:35 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=306921
Log:
- Added docs for V8Js::registerExtension(), V8Js::getExtensions(), V8JS::getPendingException.
Updated some previous docs.
Changed paths:
U phpdoc/en/trunk/reference/v8js/v8js/construct.xml
U phpdoc/en/trunk/reference/v8js/v8js/executestring.xml
U phpdoc/en/trunk/reference/v8js/v8js/getextensions.xml
U phpdoc/en/trunk/reference/v8js/v8js/getpendingexception.xml
U phpdoc/en/trunk/reference/v8js/v8js/registerextension.xml
Modified: phpdoc/en/trunk/reference/v8js/v8js/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/v8js/v8js/construct.xml 2010-12-31 12:55:23 UTC (rev 306920)
+++ phpdoc/en/trunk/reference/v8js/v8js/construct.xml 2010-12-31 13:51:35 UTC (rev 306921)
@@ -72,7 +72,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns a new V8Js context object.
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/v8js/v8js/executestring.xml
===================================================================
--- phpdoc/en/trunk/reference/v8js/v8js/executestring.xml 2010-12-31 12:55:23 UTC (rev 306920)
+++ phpdoc/en/trunk/reference/v8js/v8js/executestring.xml 2010-12-31 13:51:35 UTC (rev 306921)
@@ -18,7 +18,6 @@
<para>
Compiles and executes the string passed with <parameter>script</parameter> as
Javascript code.
</para>
-
</refsect1>
<refsect1 role="parameters">
@@ -69,8 +68,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- <function>V8Js::executeString</function> returns the last variable instantiated in
the Javascript code
- converted to matching PHP variable type.
+ Returns the last variable instantiated in the Javascript code converted to matching PHP variable
type.
</para>
</refsect1>
</refentry>
Modified: phpdoc/en/trunk/reference/v8js/v8js/getextensions.xml
===================================================================
--- phpdoc/en/trunk/reference/v8js/v8js/getextensions.xml 2010-12-31 12:55:23 UTC (rev 306920)
+++ phpdoc/en/trunk/reference/v8js/v8js/getextensions.xml 2010-12-31 13:51:35 UTC (rev 306921)
@@ -4,21 +4,18 @@
<refentry xml:id="v8js.getextensions" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>V8Js::getExtensions</refname>
- <refpurpose>The getExtensions purpose</refpurpose>
+ <refpurpose>Return an array of registered extensions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> <modifier>static</modifier>
<type>void</type><methodname>V8Js::getExtensions</methodname>
+ <modifier>public</modifier> <modifier>static</modifier>
<type>array</type><methodname>V8Js::getExtensions</methodname>
<void />
</methodsynopsis>
<para>
-
+ This function returns array of Javascript extensions registered using
<function>V8Js::registerExtension</function>.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -29,11 +26,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns an array of registered extensions or an empty array if there are none.
</para>
</refsect1>
-
</refentry>
<!-- Keep this comment at the end of the file
Modified: phpdoc/en/trunk/reference/v8js/v8js/getpendingexception.xml
===================================================================
--- phpdoc/en/trunk/reference/v8js/v8js/getpendingexception.xml 2010-12-31 12:55:23 UTC (rev 306920)
+++ phpdoc/en/trunk/reference/v8js/v8js/getpendingexception.xml 2010-12-31 13:51:35 UTC (rev 306921)
@@ -4,21 +4,19 @@
<refentry xml:id="v8js.getpendingexception" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>V8Js::getPendingException</refname>
- <refpurpose>The getPendingException purpose</refpurpose>
+ <refpurpose>Return pending uncaught Javascript exception</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>void</type><methodname>V8Js::getPendingException</methodname>
+ <modifier>public</modifier>
<type>V8JsException</type><methodname>V8Js::getPendingException</methodname>
<void />
</methodsynopsis>
<para>
-
+ Returns any pending uncaught Javascript exception as
<classname>V8JsException</classname>
+ left from earlier <function>V8Js::executeString</function> call(s).
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -29,11 +27,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Either <classname>V8JsException</classname> or &null;.
</para>
</refsect1>
-
</refentry>
<!-- Keep this comment at the end of the file
Modified: phpdoc/en/trunk/reference/v8js/v8js/registerextension.xml
===================================================================
--- phpdoc/en/trunk/reference/v8js/v8js/registerextension.xml 2010-12-31 12:55:23 UTC (rev 306920)
+++ phpdoc/en/trunk/reference/v8js/v8js/registerextension.xml 2010-12-31 13:51:35 UTC (rev 306921)
@@ -4,33 +4,32 @@
<refentry xml:id="v8js.registerextension" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>V8Js::registerExtension</refname>
- <refpurpose>The registerExtension purpose</refpurpose>
+ <refpurpose>Register Javascript extensions for V8Js</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> <modifier>static</modifier>
<type>void</type><methodname>V8Js::registerExtension</methodname>
-
<methodparam><type>string</type><parameter>ext_name</parameter></methodparam>
+ <modifier>public</modifier> <modifier>static</modifier>
<type>bool</type><methodname>V8Js::registerExtension</methodname>
+
<methodparam><type>string</type><parameter>extension_name</parameter></methodparam>
<methodparam><type>string</type><parameter>script</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>auto_enable</parameter></methodparam>
+ <methodparam
choice="opt"><type>array</type><parameter>dependencies</parameter><initializer>array()</initializer></methodparam>
+ <methodparam
choice="opt"><type>bool</type><parameter>auto_enable</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
-
+ Registers passed Javascript <parameter>script</parameter> as extension to
+ be used in <classname>V8Js</classname> contexts.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>ext_name</parameter></term>
+ <term><parameter>extension_name</parameter></term>
<listitem>
<para>
-
+ Name of the extension to be registered.
</para>
</listitem>
</varlistentry>
@@ -38,15 +37,30 @@
<term><parameter>script</parameter></term>
<listitem>
<para>
-
+ The Javascript code to be registered.
</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><parameter>dependencies</parameter></term>
+ <listitem>
+ <para>
+ Array of extension names the extension to be registered depends on. Any such extension is
+ enabled automatically when this extension is loaded.
+ <note>
+ <para>
+ All extensions, including the dependencies, must be registered before any
<classname>V8Js</classname>
+ are created which use them.
+ </para>
+ </note>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><parameter>auto_enable</parameter></term>
<listitem>
<para>
-
+ If set to &true;, the extension will be enabled automatically in all
<classname>V8Js</classname> contexts. Defaults to &false;.
</para>
</listitem>
</varlistentry>
@@ -56,7 +70,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns &true; if extension was registered succesfully, &false; otherwise.
</para>
</refsect1>