cvs: phpdoc /en/reference/spl/splfileinfo getfileinfo.xml
| From: | Brett Bieber | Date: | Fri, 14 Nov 2008 20:22:35 +0000 |
| Subject: | cvs: phpdoc /en/reference/spl/splfileinfo getfileinfo.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2540@lists.php.net to get a copy of this message | ||
saltybeagle Fri Nov 14 20:22:35 2008 UTC
Modified files:
/phpdoc/en/reference/spl/splfileinfo getfileinfo.xml
Log:
Document SplFileInfo::getFileInfo
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/splfileinfo/getfileinfo.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/spl/splfileinfo/getfileinfo.xml
diff -u phpdoc/en/reference/spl/splfileinfo/getfileinfo.xml:1.1
phpdoc/en/reference/spl/splfileinfo/getfileinfo.xml:1.2
--- phpdoc/en/reference/spl/splfileinfo/getfileinfo.xml:1.1 Fri Nov 14 18:38:21 2008
+++ phpdoc/en/reference/spl/splfileinfo/getfileinfo.xml Fri Nov 14 20:22:35 2008
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry xml:id="splfileinfo.getfileinfo" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileInfo::getFileInfo</refname>
- <refpurpose>The getFileInfo purpose</refpurpose>
+ <refpurpose>Get an SplFileInfo object for the file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>void</type><methodname>SplFileInfo::getFileInfo</methodname>
+ <modifier>public</modifier>
<type>SplFileInfo</type><methodname>SplFileInfo::getFileInfo</methodname>
<methodparam
choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
</methodsynopsis>
<para>
- The method description goes here.
+ This method gets an <classname>SplFileInfo</classname> object for the referenced
file.
</para>
</refsect1>
@@ -26,7 +26,7 @@
<term><parameter>class_name</parameter></term>
<listitem>
<para>
- Description...
+ Name of an <classname>SplFileInfo</classname> derived class to use.
</para>
</listitem>
</varlistentry>
@@ -38,29 +38,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Description...
- </para>
- </refsect1>
-
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title><function>SplFileInfo::getFileInfo</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-/* ... */
-?>
-]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
- </example>
+ An <classname>SplFileInfo</classname> object created for the file.
</para>
</refsect1>
@@ -68,7 +46,7 @@
&reftitle.seealso;
<para>
<simplelist>
- <member><methodname>Classname::Method</methodname></member>
+ <member><methodname>SplFileInfo::setInfoClass</methodname></member>
</simplelist>
</para>
</refsect1>