cvs: peardoc /en/packages/networking Net_CheckIP.xml

alexmerz Sun Jan 6 08:23:32 2002 EDT Modified files: /peardoc/en/packages/networking Net_CheckIP.xml Log: add param desc Index: peardoc/en/packages/networking/Net_CheckIP.xml diff -u peardoc/en/packages/networking/Net_CheckIP.xml:1.1 peardoc/en/packages/networking/Net_CheckIP.xml:1.2 --- peardoc/en/packages/networking/Net_CheckIP.xml:1.1 Sat Jan 5 08:37:25 2002 +++ peardoc/en/packages/networking/Net_CheckIP.xml Sun Jan 6 08:23:32 2002 @@ -1,4 +1,4 @@ -<!-- $Id: Net_CheckIP.xml,v 1.1 2002/01/05 13:37:25 alexmerz Exp $ --> +<!-- $Id: Net_CheckIP.xml,v 1.2 2002/01/06 13:23:32 alexmerz Exp $ --> <refentry id="packages.Networking.Net_CheckIP"> <refnamediv> <refname><classname>Net_CheckIP</classname></refname> @@ -13,14 +13,34 @@ <funcsynopsis> <funcprototype> <funcdef>boolean <function>Net_CheckIP::check_ip</function></funcdef> - <paramdef>string <parameter>ip</parameter></paramdef> + <paramdef>string <parameter>$ip</parameter></paramdef> </funcprototype> </funcsynopsis> <para> This function can validate if a given string has a valid IPv4 syntax. </para> + <para> + Parameter + <itemizedlist> + <listitem> + <para> + <parameter>$ip</parameter> - IP address to check + </para> + </listitem> + </itemizedlist> + </para> + <para> + Returns + <itemizedlist> + <listitem> + <para> + <parameter>boolean</parameter> - true if valid syntax + </para> + </listitem> + </itemizedlist> + </para> <example> - <title>Using checkPort</title> + <title>Using checkIP</title> <programlisting role="php"> require_once "Net_CheckIP/CheckIP.php";