Add documentation for SplFileInfo::getInode

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269038 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Brett Bieber 2008-11-15 00:47:21 +00:00
parent 848c328e55
commit ae6278eeb2

View file

@ -1,20 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="splfileinfo.getinode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileInfo::getInode</refname>
<refpurpose>The getInode purpose</refpurpose>
<refpurpose>Get the inode for the file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getInode</methodname>
<modifier>public</modifier> <type>int</type><methodname>SplFileInfo::getInode</methodname>
<void />
</methodsynopsis>
<para>
The method description goes here.
Gets the inode number for the filesystem object.
</para>
</refsect1>
@ -26,29 +26,14 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description...
Returns the inode number for the filesystem object.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<refsect1 role="errors">
&reftitle.errors;
<para>
<example>
<title><function>SplFileInfo::getInode</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
Throws RuntimeException on error.
</para>
</refsect1>
@ -56,7 +41,7 @@
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Classname::Method</methodname></member>
<member><function>fileinode</function></member>
</simplelist>
</para>
</refsect1>