[PHP-DOC] cvs: phpdoc /en/reference/mime_magic/functions mime-content-type.xml

[Mehdi Achour]

didou           Sun Jan 21 15:26:50 2007 UTC

  Modified files:              
    /phpdoc/en/reference/mime_magic/functions   mime-content-type.xml 
  Log:
  ref.mime_magic: switch to new style
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mime_magic/functions/mime-content-type.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/mime_magic/functions/mime-content-type.xml
diff -u phpdoc/en/reference/mime_magic/functions/mime-content-type.xml:1.5 
phpdoc/en/reference/mime_magic/functions/mime-content-type.xml:1.6
--- phpdoc/en/reference/mime_magic/functions/mime-content-type.xml:1.5  Sun Jan 
21 15:20:13 2007
+++ phpdoc/en/reference/mime_magic/functions/mime-content-type.xml      Sun Jan 
21 15:26:50 2007
@@ -1,12 +1,13 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <refentry id="function.mime-content-type">
  <refnamediv>
   <refname>mime_content_type</refname>
-  <refpurpose>Detect MIME Content-type for a file</refpurpose>
+  <refpurpose>Detect MIME Content-type for a file (deprecated)</refpurpose>
  </refnamediv>
- <refsect1>
-  <title>Description</title>
+ 
+ <refsect1 role="description">
+  &reftitle.description;
   <methodsynopsis>
    <type>string</type><methodname>mime_content_type</methodname>
    
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
@@ -14,12 +15,49 @@
   <para>
    Returns the MIME content type for a file as determined by using
    information from the <filename>magic.mime</filename> file. 
-   Content types are returned in MIME format, like 
<literal>text/plain</literal> 
-   or <literal>application/octet-stream</literal>.
   </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>filename</parameter></term>
+     <listitem>
+      <para>
+       Path to the tested file.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the content type in MIME format, like 
+   <literal>text/plain</literal> or 
<literal>application/octet-stream</literal>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+  &reftitle.notes;
+  <warning>
+   <para>
+    This function has been deprecated as the PECL extension
+    <link linkend="ref.fileinfo">Fileinfo</link> provides the same
+    functionality (and more) in a much cleaner way.
+   </para>
+  </warning>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
   <para>
    <example>
-    <title><function>mime_content_type</function> example</title>
+    <title><function>mime_content_type</function> Example</title>
     <programlisting role="php">
 <![CDATA[
 <?php
@@ -38,6 +76,17 @@
    </example>
   </para>
  </refsect1>
+ 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member>
+     <link linkend="ref.fileinfo">Fileinfo</link> for a replacement
+    </member>
+   </simplelist>
+  </para>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file