php-doc-en/reference/bbcode/functions/bbcode-parse.xml
De Cock Xavier e608cfea02 Applied the patch from M. Sokolewicz <tularis@php.net> (thanks a lot for
your Help).

+ Added corrections about file_info reference
+ Added Minor Typo corrections
+ Removed all tabs (i found)

+ Aspelled everything twice, 'should help

Sorry, once more for my previous submission :">

Xavier.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@240291 c90b9560-bf6c-de11-be94-00142212c4b1
2007-07-24 21:55:02 +00:00

73 lines
1.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.bbcode_parse" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>bbcode_parse</refname>
<refpurpose>Parse a string following a given rule set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>bbcode_parse</methodname>
<methodparam><type>resource</type><parameter>bbcode_container</parameter></methodparam>
<methodparam><type>string</type><parameter>to_parse</parameter></methodparam>
</methodsynopsis>
<para>
This function parse the string to_parse following the rules in the
bbcode_container created by <function>bbcode_create</function>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bbcode_container</parameter></term>
<listitem>
<para>
BBCode_Container resource returned by <function>bbcode_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>to_parse</parameter></term>
<listitem>
<para>
The string we need to parse.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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:"../../../../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
-->