From a9e2c9e827596c3a2427487b9ea5c86eee5d1181 Mon Sep 17 00:00:00 2001
From: Brett Bieber <saltybeagle@php.net>
Date: Sat, 15 Nov 2008 13:12:38 +0000
Subject: [PATCH] Document SplFileInfo::getOwner

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

diff --git a/reference/spl/splfileinfo/getowner.xml b/reference/spl/splfileinfo/getowner.xml
index 8ee5886210..9b8ea7307b 100644
--- a/reference/spl/splfileinfo/getowner.xml
+++ b/reference/spl/splfileinfo/getowner.xml
@@ -1,20 +1,20 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="splfileinfo.getowner" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>SplFileInfo::getOwner</refname>
-  <refpurpose>The getOwner purpose</refpurpose>
+  <refpurpose>Get the owner of the file</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getOwner</methodname>
+   <modifier>public</modifier> <type>int</type><methodname>SplFileInfo::getOwner</methodname>
    <void />
   </methodsynopsis>
   <para>
-   The method description goes here.
+   Gets the file owner. The owner ID is returned in numerical format.
   </para>
  </refsect1>
 
@@ -26,7 +26,14 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
+   The owner id in numerical format.
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Throws RuntimeException on error.
   </para>
  </refsect1>
 
@@ -38,16 +45,11 @@
     <programlisting role="php">
 <![CDATA[
 <?php
-/* ... */
+$info = new SplFileInfo('file.txt');
+print_r(posix_getpwuid($info->getOwner()));
 ?>
 ]]>
     </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
    </example>
   </para>
  </refsect1>
@@ -56,7 +58,8 @@
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
+    <member><function>posix_getpwuid</function></member>
+    <member><methodname>SplFileInfo::getGroup</methodname></member>
    </simplelist>
   </para>
  </refsect1>