fix whitespaces + add role attribute to description section

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@187899 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jean-Sébastien Goupil 2005-06-07 22:42:21 +00:00
parent 3b6e036365
commit 217bd9f99f

View file

@ -1,66 +1,70 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/var.xml, last change in rev 1.84 -->
<refentry id="function.var-dump">
<refnamediv>
<refname>var_dump</refname>
<refpurpose>Dumps information about a variable</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>var_dump</methodname>
<methodparam><type>mixed</type><parameter>expression</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>expression</parameter></methodparam>
<methodparam choice="opt"><parameter>...</parameter></methodparam>
</methodsynopsis>
<simpara>
This function displays structured information about one or more
expressions that includes its type and value. Arrays and objects are
explored recursively with values indented to show structure.
</simpara>
<simpara>
In PHP 5 only public, private and protected properties of objects will be
returned in the output.
</simpara>
&tip.ob-capture;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>expression</parameter></term>
<listitem>
<para>
The variable you want to export.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>var_dump</function> example</title>
<programlisting role="php">
<refentry id="function.var-dump">
<refnamediv>
<refname>var_dump</refname>
<refpurpose>Dumps information about a variable</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>var_dump</methodname>
<methodparam><type>mixed</type><parameter>expression</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>expression</parameter></methodparam>
<methodparam choice="opt"><parameter>...</parameter></methodparam>
</methodsynopsis>
<simpara>
This function displays structured information about one or more
expressions that includes its type and value. Arrays and objects are
explored recursively with values indented to show structure.
</simpara>
<simpara>
In PHP 5 only public, private and protected properties of objects will be
returned in the output.
</simpara>
&tip.ob-capture;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>expression</parameter></term>
<listitem>
<para>
The variable you want to export.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>var_dump</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$a = array(1, 2, array("a", "b", "c"));
var_dump($a);
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(3) {
[0]=>
@ -78,8 +82,8 @@ array(3) {
}
}
]]>
</screen>
<programlisting role="php">
</screen>
<programlisting role="php">
<![CDATA[
<?php
@ -89,27 +93,28 @@ var_dump($b, $c);
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
float(3.1)
bool(true)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>var_export</function></member>
<member><function>print_r</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>var_export</function></member>
<member><function>print_r</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: