From 71f186aa50595c001550a78e1018d7a8bbca5c67 Mon Sep 17 00:00:00 2001
From: Brett Bieber <saltybeagle@php.net>
Date: Fri, 14 Nov 2008 20:22:35 +0000
Subject: [PATCH] Document SplFileInfo::getFileInfo

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269024 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/splfileinfo/getfileinfo.xml | 36 +++++------------------
 1 file changed, 7 insertions(+), 29 deletions(-)

diff --git a/reference/spl/splfileinfo/getfileinfo.xml b/reference/spl/splfileinfo/getfileinfo.xml
index 60ad8fde40..0246d1f1b6 100644
--- a/reference/spl/splfileinfo/getfileinfo.xml
+++ b/reference/spl/splfileinfo/getfileinfo.xml
@@ -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>