cvs: phpdoc /en/reference/bcompiler/functions bcompiler-load-exe.xml bcompiler-load.xml bcompiler-parse-class.xml bcompiler-read.xml
bcompiler-write-class.xml bcompiler-write-constant.xml bcompiler-write-exe-footer.xml bcompiler-write-file.xml bcompiler-write-footer.xml
bcompiler-write-function.xml bcompiler-write-functions-from-file.xml bcompiler-write-header.xml
| From: | Mehdi Achour | Date: | Sat, 17 Feb 2007 18:45:21 +0000 |
| Subject: | cvs: phpdoc /en/reference/bcompiler/functions bcompiler-load-exe.xml bcompiler-load.xml bcompiler-parse-class.xml bcompiler-read.xml bcompiler-write-class.xml bcompiler-write-constant.xml bcompiler-write-exe-footer.xml bcompiler-write-file.xml bcompiler-write-footer.xml bcompiler-write-function.xml bcompiler-write-functions-from-file.xml bcompiler-write-header.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969375502@lists.php.net to get a copy of this message | ||
didou Sat Feb 17 18:45:21 2007 UTC
Modified files:
/phpdoc/en/reference/bcompiler/functions bcompiler-load-exe.xml
bcompiler-load.xml
bcompiler-parse-class.xml
bcompiler-read.xml
bcompiler-write-class.xml
bcompiler-write-constant.xml
bcompiler-write-exe-footer.xml
bcompiler-write-file.xml
bcompiler-write-footer.xml
bcompiler-write-function.xml
bcompiler-write-functions-from-file.xml
bcompiler-write-header.xml
Log:
ref.bcompiler: switch to new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml Sat Feb 17 18:45:21 2007 @@ -1,21 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-load-exe"> <refnamediv> <refname>bcompiler_load_exe</refname> <refpurpose>Reads and creates classes from a bcompiler exe file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_load_exe</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> Reads data from a bcompiler exe file and creates classes from the bytecodes. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The exe file path, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_load</function> example</title> @@ -32,6 +58,12 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml Sat Feb 17 18:45:21 2007 @@ -1,28 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-load"> <refnamediv> <refname>bcompiler_load</refname> <refpurpose>Reads and creates classes from a bz compressed file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_load</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; - <note> <para> - Please use include or require statements to parse bytecodes, it's more - portable and convenient way than using this function. + Reads data from a bzcompressed file and creates classes from the bytecodes. </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Reads data from a bzcompressed file and creates classes from the bytecodes. - Please note that this function won't execute script body code contained in the bytecode file. + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The bzcompressed file path, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_load</function> example</title> @@ -40,6 +59,22 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + <note> + <para> + Please use include or require statements to parse bytecodes, it's more + portable and convenient way than using this function. + </para> + <para> + Please note that this function won't execute script body code contained + in the bytecode file. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.6 phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.7 --- phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.6 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml Sat Feb 17 18:45:21 2007 @@ -1,27 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcompiler-parse-class"> <refnamediv> <refname>bcompiler_parse_class</refname> <refpurpose>Reads the bytecodes of a class and calls back to a user function</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_parse_class</methodname> <methodparam><type>string</type><parameter>class</parameter></methodparam> <methodparam><type>string</type><parameter>callback</parameter></methodparam> </methodsynopsis> - <note> <para> - This function has been removed from bcompiler and is no - longer available as of bcompiler 0.5. + Reads the bytecodes of a class and calls back to a user function. </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Reads the bytecodes of a class and calls back to a user function. + <variablelist> + <varlistentry> + <term><parameter>class</parameter></term> + <listitem> + <para> + The class name, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>callback</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_parse_class</function> example</title> @@ -30,7 +58,7 @@ <?php function readByteCodes($data) { - print_r($data); + print_r($data); } bcompiler_parse_class("DB","readByteCodes"); @@ -41,6 +69,18 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + <note> + <para> + This function has been removed from bcompiler and is no longer available + as of bcompiler 0.5. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.5 phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.6 --- phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.5 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml Sat Feb 17 18:45:21 2007 @@ -1,28 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.bcompiler-read"> <refnamediv> <refname>bcompiler_read</refname> <refpurpose>Reads and creates classes from a filehandle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_read</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; - <note> <para> - Please use include or require statements to parse - bytecodes, it's more portable and convenient way than using this function. + Reads data from a open file handle and creates classes from the bytecodes. </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Reads data from a open file handle and creates classes from the bytecodes. - Please note that this function won't execute script body code contained in the bytecode file. + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_read</function> example</title> @@ -40,6 +59,22 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + <note> + <para> + Please use include or require statements to parse bytecodes, it's more + portable and convenient way than using this function. + </para> + <para> + Please note that this function won't execute script body code contained + in the bytecode file. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml Sat Feb 17 18:45:21 2007 @@ -1,26 +1,65 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-class"> <refnamediv> <refname>bcompiler_write_class</refname> <refpurpose>Writes an defined class as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_class</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>className</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>extends</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - This reads the bytecodes from PHP for an existing class, and writes them - to the open file handle, It does not perform dependency checking, so make - sure you write the classes in an order that will not result in an - 'undefined class' occurring when you load it. + Reads the bytecodes from PHP for an existing class, and writes them to the + open file handle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>className</parameter></term> + <listitem> + <para> + The class name, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>extends</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_class</function> example</title> @@ -41,11 +80,30 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + <note> + <para> + This function does not perform dependency checking, so make sure you + write the classes in an order that will not result in an + <literal>undefined class</literal> error occurring when you load it. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, - and <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.2 phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.3 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.2 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml Sat Feb 17 18:45:21 2007 @@ -1,23 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.3 $ --> <refentry id="function.bcompiler-write-constant"> <refnamediv> <refname>bcompiler_write_constant</refname> <refpurpose>Writes a defined constant as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_constant</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>constantName</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - This function reads the bytecodes from PHP for an existing constant, and - writes them to the open file handle. + Reads the bytecodes from PHP for an existing constant, and writes them to + the open file handle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>constantName</parameter></term> + <listitem> + <para> + The name of the defined constant, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_constant</function> example</title> @@ -37,11 +71,23 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, - and <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml Sat Feb 17 18:45:21 2007 @@ -1,23 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-exe-footer"> <refnamediv> <refname>bcompiler_write_exe_footer</refname> <refpurpose>Writes the start pos, and sig to the end of a exe type file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_exe_footer</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>int</type><parameter>startpos</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; - <para> - An EXE (or self executable) file consists of 3 parts, - </para> <para> + An EXE (or self executable) file consists of 3 parts: <simplelist> <member> The stub (executable code, e.g. a compiled C program) that loads PHP @@ -27,33 +24,72 @@ <member>The Bytecodes (uncompressed only for the moment)</member> <member>The bcompiler EXE footer</member> </simplelist> - The <parameter>startpos</parameter> is the file position at - which the Bytecodes start, and can be obtained using ftell($fh). </para> <para> To obtain a suitable stub you can compile php_embed-based stub phpe.c located in the examples/embed directory on bcompiler's CVS. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>startpos</parameter></term> + <listitem> + <para> + The file position at which the Bytecodes start, and can be obtained + using <function>ftell</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_footer</function> example</title> <programlisting role="php"> <![CDATA[ <?php + /* creating the output file (example.exe) */ $fh = fopen("example.exe", "w"); + /* 1) writing a stub (phpe.exe) */ $size = filesize("phpe.exe"); $fr = fopen("phpe.exe", "r"); fwrite($fh, fread($fr, $size), $size); $startpos = ftell($fh); + /* 2) writing bytecodes */ bcompiler_write_header($fh); bcompiler_write_class($fh, "myclass"); bcompiler_write_function($fh, "main"); bcompiler_write_footer($fh); + /* 3) writing EXE footer */ bcompiler_write_exe_footer($fh, $startpos); + /* closing the output file */ fclose($fh); ?> @@ -61,12 +97,24 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, - <function>bcompiler_write_class</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_class</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml Sat Feb 17 18:45:21 2007 @@ -1,22 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-file"> <refnamediv> <refname>bcompiler_write_file</refname> <refpurpose>Writes a php source file as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_file</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> This function complies specified source file into bytecodes, and writes them to the open file handle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The source file path, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_file</function> example</title> @@ -38,11 +73,23 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml Sat Feb 17 18:45:21 2007 @@ -1,21 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-footer"> <refnamediv> <refname>bcompiler_write_footer</refname> <refpurpose>Writes the single character \x00 to indicate End of compiled data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_footer</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> Writes the single character \x00 to indicate End of compiled data. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_footer</function> example</title> @@ -34,11 +60,22 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_header</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.3 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml Sat Feb 17 18:45:21 2007 @@ -1,25 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.bcompiler-write-function"> <refnamediv> <refname>bcompiler_write_function</refname> <refpurpose>Writes an defined function as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_function</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>functionName</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - This reads the bytecodes from PHP for an existing function, and writes - them to the open file handle. Order is not important, (eg. if function b - uses function a, and you compile it like the example below, it will - work perfectly OK). + Reads the bytecodes from PHP for an existing function, and writes them to + the open file handle. Order is not important, (eg. if function b uses + function a, and you compile it like the example below, it will work + perfectly OK). </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>functionName</parameter></term> + <listitem> + <para> + The function name, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_function</function> example</title> @@ -38,11 +72,23 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.2 phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.3 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.2 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml Sat Feb 17 18:45:21 2007 @@ -1,24 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.3 $ --> <refentry id="function.bcompiler-write-functions-from-file"> <refnamediv> <refname>bcompiler_write_functions_from_file</refname> <refpurpose>Writes all functions defined in a file as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_functions_from_file</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>fileName</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - This function searches for all functions declared in the given file, and - writes their correspondent bytecodes to the open file handle. Always - remember to include/require the file you intend to compile. + Searches for all functions declared in the given file, and writes their + correspondent bytecodes to the open file handle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fileName</parameter></term> + <listitem> + <para> + The file to be compiled. + You must always include or require the file you intend to compile. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_functions_from_file</function> example</title> @@ -38,11 +72,23 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml Sat Feb 17 18:45:21 2007 @@ -1,24 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-header"> <refnamediv> <refname>bcompiler_write_header</refname> <refpurpose>Writes the bcompiler header</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_header</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>write_ver</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> Writes the header part of a bcompiler file. - Optional second parameter can be used to write bytecode in a previously - used format, so that you can use it with older versions of bcompiler. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>write_ver</parameter></term> + <listitem> + <para> + Can be used to write bytecode in a previously used format, so that you + can use it with older versions of bcompiler. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_header</function> example</title> @@ -36,13 +69,22 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_file</function>, - <function>bcompiler_write_class</function>, - <function>bcompiler_write_function</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml Sat Feb 17 18:45:21 2007 @@ -1,21 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-load-exe"> <refnamediv> <refname>bcompiler_load_exe</refname> <refpurpose>Reads and creates classes from a bcompiler exe file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_load_exe</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> Reads data from a bcompiler exe file and creates classes from the bytecodes. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The exe file path, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_load</function> example</title> @@ -32,6 +58,12 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml Sat Feb 17 18:45:21 2007 @@ -1,28 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-load"> <refnamediv> <refname>bcompiler_load</refname> <refpurpose>Reads and creates classes from a bz compressed file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_load</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; - <note> <para> - Please use include or require statements to parse bytecodes, it's more - portable and convenient way than using this function. + Reads data from a bzcompressed file and creates classes from the bytecodes. </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Reads data from a bzcompressed file and creates classes from the bytecodes. - Please note that this function won't execute script body code contained in the bytecode file. + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The bzcompressed file path, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_load</function> example</title> @@ -40,6 +59,22 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + <note> + <para> + Please use include or require statements to parse bytecodes, it's more + portable and convenient way than using this function. + </para> + <para> + Please note that this function won't execute script body code contained + in the bytecode file. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.6 phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.7 --- phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.6 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml Sat Feb 17 18:45:21 2007 @@ -1,27 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.bcompiler-parse-class"> <refnamediv> <refname>bcompiler_parse_class</refname> <refpurpose>Reads the bytecodes of a class and calls back to a user function</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_parse_class</methodname> <methodparam><type>string</type><parameter>class</parameter></methodparam> <methodparam><type>string</type><parameter>callback</parameter></methodparam> </methodsynopsis> - <note> <para> - This function has been removed from bcompiler and is no - longer available as of bcompiler 0.5. + Reads the bytecodes of a class and calls back to a user function. </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Reads the bytecodes of a class and calls back to a user function. + <variablelist> + <varlistentry> + <term><parameter>class</parameter></term> + <listitem> + <para> + The class name, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>callback</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_parse_class</function> example</title> @@ -30,7 +58,7 @@ <?php function readByteCodes($data) { - print_r($data); + print_r($data); } bcompiler_parse_class("DB","readByteCodes"); @@ -41,6 +69,18 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + <note> + <para> + This function has been removed from bcompiler and is no longer available + as of bcompiler 0.5. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.5 phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.6 --- phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.5 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml Sat Feb 17 18:45:21 2007 @@ -1,28 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.bcompiler-read"> <refnamediv> <refname>bcompiler_read</refname> <refpurpose>Reads and creates classes from a filehandle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_read</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; - <note> <para> - Please use include or require statements to parse - bytecodes, it's more portable and convenient way than using this function. + Reads data from a open file handle and creates classes from the bytecodes. </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Reads data from a open file handle and creates classes from the bytecodes. - Please note that this function won't execute script body code contained in the bytecode file. + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_read</function> example</title> @@ -40,6 +59,22 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + <note> + <para> + Please use include or require statements to parse bytecodes, it's more + portable and convenient way than using this function. + </para> + <para> + Please note that this function won't execute script body code contained + in the bytecode file. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml Sat Feb 17 18:45:21 2007 @@ -1,26 +1,65 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-class"> <refnamediv> <refname>bcompiler_write_class</refname> <refpurpose>Writes an defined class as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_class</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>className</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>extends</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - This reads the bytecodes from PHP for an existing class, and writes them - to the open file handle, It does not perform dependency checking, so make - sure you write the classes in an order that will not result in an - 'undefined class' occurring when you load it. + Reads the bytecodes from PHP for an existing class, and writes them to the + open file handle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>className</parameter></term> + <listitem> + <para> + The class name, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>extends</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_class</function> example</title> @@ -41,11 +80,30 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + <note> + <para> + This function does not perform dependency checking, so make sure you + write the classes in an order that will not result in an + <literal>undefined class</literal> error occurring when you load it. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, - and <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.2 phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.3 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.2 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml Sat Feb 17 18:45:21 2007 @@ -1,23 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.3 $ --> <refentry id="function.bcompiler-write-constant"> <refnamediv> <refname>bcompiler_write_constant</refname> <refpurpose>Writes a defined constant as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_constant</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>constantName</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - This function reads the bytecodes from PHP for an existing constant, and - writes them to the open file handle. + Reads the bytecodes from PHP for an existing constant, and writes them to + the open file handle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>constantName</parameter></term> + <listitem> + <para> + The name of the defined constant, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_constant</function> example</title> @@ -37,11 +71,23 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, - and <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml Sat Feb 17 18:45:21 2007 @@ -1,23 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-exe-footer"> <refnamediv> <refname>bcompiler_write_exe_footer</refname> <refpurpose>Writes the start pos, and sig to the end of a exe type file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_exe_footer</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>int</type><parameter>startpos</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; - <para> - An EXE (or self executable) file consists of 3 parts, - </para> <para> + An EXE (or self executable) file consists of 3 parts: <simplelist> <member> The stub (executable code, e.g. a compiled C program) that loads PHP @@ -27,33 +24,72 @@ <member>The Bytecodes (uncompressed only for the moment)</member> <member>The bcompiler EXE footer</member> </simplelist> - The <parameter>startpos</parameter> is the file position at - which the Bytecodes start, and can be obtained using ftell($fh). </para> <para> To obtain a suitable stub you can compile php_embed-based stub phpe.c located in the examples/embed directory on bcompiler's CVS. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>startpos</parameter></term> + <listitem> + <para> + The file position at which the Bytecodes start, and can be obtained + using <function>ftell</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_footer</function> example</title> <programlisting role="php"> <![CDATA[ <?php + /* creating the output file (example.exe) */ $fh = fopen("example.exe", "w"); + /* 1) writing a stub (phpe.exe) */ $size = filesize("phpe.exe"); $fr = fopen("phpe.exe", "r"); fwrite($fh, fread($fr, $size), $size); $startpos = ftell($fh); + /* 2) writing bytecodes */ bcompiler_write_header($fh); bcompiler_write_class($fh, "myclass"); bcompiler_write_function($fh, "main"); bcompiler_write_footer($fh); + /* 3) writing EXE footer */ bcompiler_write_exe_footer($fh, $startpos); + /* closing the output file */ fclose($fh); ?> @@ -61,12 +97,24 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, - <function>bcompiler_write_class</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_class</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml Sat Feb 17 18:45:21 2007 @@ -1,22 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-file"> <refnamediv> <refname>bcompiler_write_file</refname> <refpurpose>Writes a php source file as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_file</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> This function complies specified source file into bytecodes, and writes them to the open file handle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The source file path, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_file</function> example</title> @@ -38,11 +73,23 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml Sat Feb 17 18:45:21 2007 @@ -1,21 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-footer"> <refnamediv> <refname>bcompiler_write_footer</refname> <refpurpose>Writes the single character \x00 to indicate End of compiled data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_footer</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> Writes the single character \x00 to indicate End of compiled data. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_footer</function> example</title> @@ -34,11 +60,22 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_header</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.3 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml Sat Feb 17 18:45:21 2007 @@ -1,25 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.bcompiler-write-function"> <refnamediv> <refname>bcompiler_write_function</refname> <refpurpose>Writes an defined function as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_function</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>functionName</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - This reads the bytecodes from PHP for an existing function, and writes - them to the open file handle. Order is not important, (eg. if function b - uses function a, and you compile it like the example below, it will - work perfectly OK). + Reads the bytecodes from PHP for an existing function, and writes them to + the open file handle. Order is not important, (eg. if function b uses + function a, and you compile it like the example below, it will work + perfectly OK). </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>functionName</parameter></term> + <listitem> + <para> + The function name, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_function</function> example</title> @@ -38,11 +72,23 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.2 phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.3 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.2 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml Sat Feb 17 18:45:21 2007 @@ -1,24 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.3 $ --> <refentry id="function.bcompiler-write-functions-from-file"> <refnamediv> <refname>bcompiler_write_functions_from_file</refname> <refpurpose>Writes all functions defined in a file as bytecodes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_functions_from_file</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam><type>string</type><parameter>fileName</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - This function searches for all functions declared in the given file, and - writes their correspondent bytecodes to the open file handle. Always - remember to include/require the file you intend to compile. + Searches for all functions declared in the given file, and writes their + correspondent bytecodes to the open file handle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fileName</parameter></term> + <listitem> + <para> + The file to be compiled. + You must always include or require the file you intend to compile. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_functions_from_file</function> example</title> @@ -38,11 +72,23 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_header</function></member> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.4 Sat Feb 17 18:44:52 2007 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml Sat Feb 17 18:45:21 2007 @@ -1,24 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bcompiler-write-header"> <refnamediv> <refname>bcompiler_write_header</refname> <refpurpose>Writes the bcompiler header</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>bcompiler_write_header</methodname> <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>write_ver</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> Writes the header part of a bcompiler file. - Optional second parameter can be used to write bytecode in a previously - used format, so that you can use it with older versions of bcompiler. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filehandle</parameter></term> + <listitem> + <para> + A file handle as returned by <function>fopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>write_ver</parameter></term> + <listitem> + <para> + Can be used to write bytecode in a previously used format, so that you + can use it with older versions of bcompiler. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bcompiler_write_header</function> example</title> @@ -36,13 +69,22 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bcompiler_write_file</function>, - <function>bcompiler_write_class</function>, - <function>bcompiler_write_function</function>, and - <function>bcompiler_write_footer</function>. + <simplelist> + <member><function>bcompiler_write_footer</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file