[PHP-DOC] cvs: phpdoc /en/functions nis.xml From: Egon Schmid (eschmid <email protected>)
Date: 07/22/00

eschmid Sat Jul 22 12:05:55 2000 EDT

  Modified files:
    /phpdoc/en/functions nis.xml
  Log:
  Some cosmetic changes and changed string[] to array.
  
Index: phpdoc/en/functions/nis.xml
diff -u phpdoc/en/functions/nis.xml:1.5 phpdoc/en/functions/nis.xml:1.6
--- phpdoc/en/functions/nis.xml:1.5 Sat Jun 24 08:40:15 2000
+++ phpdoc/en/functions/nis.xml Sat Jul 22 12:05:55 2000
@@ -19,7 +19,7 @@
   <refentry id="function.yp-get-default-domain">
    <refnamediv>
     <refname>yp_get_default_domain</refname>
- <refpurpose>Fetches the machine's default NIS domain.</refpurpose>
+ <refpurpose>Fetches the machine's default NIS domain</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -30,7 +30,7 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yp_get_default_domain</function> returns the default
+ <function>Yp_get_default_domain</function> returns the default
      domain of the node or FALSE. Can be used as the domain parameter
      for successive NIS calls.
     </para>
@@ -45,8 +45,8 @@
       <title>Example for the default domain</title>
       <programlisting role="php">
 &lt;?php
- $domain = yp_get_default_domain();
- echo "Default NIS domain is: " . $domain;
+$domain = yp_get_default_domain();
+echo "Default NIS domain is: " . $domain;
 ?>
       </programlisting>
      </example>
@@ -63,7 +63,7 @@
   <refentry id="function.yp-order">
    <refnamediv>
     <refname>yp_order</refname>
- <refpurpose>Returns the order number for a map.</refpurpose>
+ <refpurpose>Returns the order number for a map</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -75,7 +75,7 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yp_order</function> returns the order number for a map
+ <function>Yp_order</function> returns the order number for a map
      or FALSE.
     </para>
     <para>
@@ -102,8 +102,9 @@
   <refentry id="function.yp-master">
    <refnamediv>
     <refname>yp_master</refname>
- <refpurpose>Returns the machine
- name of the master NIS server for a map.</refpurpose>
+ <refpurpose>
+ Returns the machine name of the master NIS server for a map
+ </refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -115,7 +116,7 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yp_master</function> returns the machine name of
+ <function>Yp_master</function> returns the machine name of
      the master NIS server for a map.
     </para>
     <para>
@@ -123,8 +124,8 @@
       <title>Example for the NIS master</title>
       <programlisting role="php">
 &lt;?php
- $number = yp_master($domain, $mapname);
- echo "Master for this map is: " . $master;
+$number = yp_master ($domain, $mapname);
+echo "Master for this map is: " . $master;
 ?>
       </programlisting>
      </example>
@@ -142,7 +143,7 @@
   <refentry id="function.yp-match">
    <refnamediv>
     <refname>yp_match</refname>
- <refpurpose>Returns the matched line.</refpurpose>
+ <refpurpose>Returns the matched line</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -155,7 +156,7 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yp_match</function> returns the value associated with
+ <function>Yp_match</function> returns the value associated with
      the passed key out of the specified map or FALSE. This key must
      be exact.</para>
     <para>
@@ -163,8 +164,8 @@
       <title>Example for NIS match</title>
       <programlisting role="php">
 &lt;?php
- $entry = yp_match($domain, "passwd.byname", "joe");
- echo "Matched entry is: " . $entry;
+$entry = yp_match ($domain, "passwd.byname", "joe");
+echo "Matched entry is: " . $entry;
 ?>
       </programlisting>
      </example>
@@ -186,20 +187,21 @@
   <refentry id="function.yp-first">
    <refnamediv>
     <refname>yp_first</refname>
- <refpurpose> Returns the first key-value pair from the named
- map.</refpurpose>
+ <refpurpose>
+ Returns the first key-value pair from the named map
+ </refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
- <funcdef>string[] <function>yp_first</function></funcdef>
+ <funcdef>array <function>yp_first</function></funcdef>
       <paramdef>string <parameter>domain</parameter></paramdef>
       <paramdef>string <parameter>map</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yp_first</function> returns the first key-value
+ <function>Yp_first</function> returns the first key-value
      pair from the named map in the named domain, otherwise FALSE.
     </para>
     <para>
@@ -235,14 +237,14 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
- <funcdef>string[] <function>yp_next</function></funcdef>
+ <funcdef>array <function>yp_next</function></funcdef>
       <paramdef>string <parameter>domain</parameter></paramdef>
       <paramdef>string <parameter>map</parameter></paramdef>
       <paramdef>string <parameter>key</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yp_next</function> returns the next key-value pair in
+ <function>Yp_next</function> returns the next key-value pair in
      the named map after the specified key or FALSE.
     </para>
     <para>
@@ -250,16 +252,16 @@
       <title>Example for NIS next</title>
       <programlisting role="php">
 &lt;?php
- $entry = yp_next($domain, "passwd.byname", "joe");
+$entry = yp_next ($domain, "passwd.byname", "joe");
 
- if(!$entry) {
- echo yp_errno() . ": " . yp_err_string();
- }
+if (!$entry) {
+ echo yp_errno() . ": " . yp_err_string();
+}
 
- $key = key($entry);
+$key = key ($entry);
 
- echo "The next entry after joe has key " . $key
- . " and value " . $entry[$key];
+echo "The next entry after joe has key " . $key
+ . " and value " . $entry[$key];
 ?>
       </programlisting>
      </example>
@@ -278,19 +280,21 @@
     
   <refentry id="function.yp-errno">
    <refnamediv>
- <refname>yp_errno</refname> <refpurpose>Returns the error code of
- the previous operation.</refpurpose>
+ <refname>yp_errno</refname>
+ <refpurpose>
+ Returns the error code of the previous operation
+ </refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
       <funcdef>int <function>yp_errno</function></funcdef>
- <paramdef></paramdef>
+ <void/>
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yp_errno</function> returns the error code of the
+ <function>Yp_errno</function> returns the error code of the
      previous operation.
     </para>
     <para>
@@ -317,8 +321,7 @@
      </simplelist>
     </para>
     <para>
- See also: <link linkend="function.yp-err-string">
- yp_err_string</link>
+ See also <function>yp_err_string</function>.
     </para>
    </refsect1>
   </refentry>
@@ -331,8 +334,7 @@
    <refnamediv>
    <refname>yp_err_string</refname>
    <refpurpose>
- Returns the error string associated with the previous
- operation.
+ Returns the error string associated with the previous operation
    </refpurpose>
    </refnamediv>
    <refsect1>
@@ -344,7 +346,7 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yp_err_string</function> returns the error message
+ <function>Yp_err_string</function> returns the error message
      associated with the previous operation. Useful to indicate what
      exactly went wrong.
     </para>
@@ -356,9 +358,10 @@
     echo "Error: " . yp_err_string();
 ?>
       </programlisting>
- </example></para>
+ </example>
+ </para>
     <para>
- See also: <link linkend="function.yp-errno"> yp_errno</link>
+ See also <function>yp_errno</function>.
     </para>
    </refsect1>
   </refentry>