svn: /pear/peardoc/trunk/en/package/networking/ net-ipv6/getnetmaskspec.xml net-ipv6/getprefixlength.xml net-ipv6/parseaddress.xml net-ipv6/removeprefixlength.xml net-ipv6.xml

[email protected] (Alexander Merz) Mon, 13 Sep 2010 02:12:03 +0000

Newsgroups	php.pear.doc
Message-ID	<[email protected]>

alexmerz                                 Mon, 13 Sep 2010 02:12:03 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=303304

Log:
add missing docs for new methods

Changed paths:
    A   pear/peardoc/trunk/en/package/networking/net-ipv6/getnetmaskspec.xml
    A   pear/peardoc/trunk/en/package/networking/net-ipv6/getprefixlength.xml
    A   pear/peardoc/trunk/en/package/networking/net-ipv6/parseaddress.xml
    A   pear/peardoc/trunk/en/package/networking/net-ipv6/removeprefixlength.xml
    U   pear/peardoc/trunk/en/package/networking/net-ipv6.xml

svn-diffs-303304.txt (text/x-diff, 9.7 KB)

Added: pear/peardoc/trunk/en/package/networking/net-ipv6/getnetmaskspec.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ipv6/getnetmaskspec.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/package/networking/net-ipv6/getnetmaskspec.xml	2010-09-13 02:12:03 UTC (rev 303304)
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.networking.net-ipv6.getnetmaskspec">
+   <refnamediv>
+    <refname>Net_IPv6::getNetmaskSpec()</refname>
+    <refpurpose>
+     Returns a possible existing netmask specification at an IP addresse.
+	</refpurpose>
+   </refnamediv>
+   <refsynopsisdiv>
+    <funcsynopsis>
+     <funcsynopsisinfo>
+      require_once 'Net/IPv6.php';
+     </funcsynopsisinfo>
+    <funcprototype>
+     <funcdef>string <function>Net_IPv6::getNetmaskSpec</function></funcdef>
+     <paramdef choice="req">string <parameter>$ip</parameter></paramdef>
+    </funcprototype>
+    </funcsynopsis>
+   </refsynopsisdiv>
+   <refsection xml:id="package.networking.net-ipv6.getnetmaskspec.desc">
+    &title.desc;
+    <para>
+     Returns a possible existing netmask specification at an IP addresse.
+	</para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.getnetmaskspec.parameter">
+    &title.param;
+    <para>
+     <itemizedlist>
+      <listitem>
+       <para>
+        <parameter>string $ip</parameter> -  the IP address in Hex format, compressed IPs are allowed
+       </para>
+      </listitem>
+     </itemizedlist>
+    </para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.getnetmaskspec.return">
+    &title.returns;
+    <para>
+     <parameter>string</parameter> - the netmask specification.
+    </para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.getnetmaskspec.note">
+    &title.note;
+    &note.canstatic;
+    <simpara>
+     Method available since: Release 1.1.0
+    </simpara>
+   </refsection>
+  </refentry>

Added: pear/peardoc/trunk/en/package/networking/net-ipv6/getprefixlength.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ipv6/getprefixlength.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/package/networking/net-ipv6/getprefixlength.xml	2010-09-13 02:12:03 UTC (rev 303304)
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.networking.net-ipv6.getprefixlength">
+   <refnamediv>
+    <refname>Net_IPv6::getPrefixLength()</refname>
+    <refpurpose>
+	 Tests for a prefix length specification in the address and returns the prefix length, if exists.
+	</refpurpose>
+   </refnamediv>
+   <refsynopsisdiv>
+    <funcsynopsis>
+     <funcsynopsisinfo>
+      require_once 'Net/IPv6.php';
+     </funcsynopsisinfo>
+    <funcprototype>
+     <funcdef>string <function>Net_IPv6::getPrefixLength</function></funcdef>
+     <paramdef choice="req">string <parameter>$ip</parameter></paramdef>
+    </funcprototype>
+    </funcsynopsis>
+   </refsynopsisdiv>
+   <refsection xml:id="package.networking.net-ipv6.getprefixlength.desc">
+    &title.desc;
+    <para>
+     Tests for a prefix length specification in the address and returns the prefix length, if exists.
+	</para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.getprefixlength.parameter">
+    &title.param;
+    <para>
+     <itemizedlist>
+      <listitem>
+       <para>
+        <parameter>string $ip</parameter> -  a valid ipv6 address
+       </para>
+      </listitem>
+     </itemizedlist>
+    </para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.getprefixlength.return">
+    &title.returns;
+    <para>
+     <parameter>mixed</parameter> - the prefix as String or false, if prefix was not found.
+    </para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.getprefixlength.note">
+    &title.note;
+    &note.canstatic;
+    <simpara>
+     Method available since: Release 1.1.0
+    </simpara>
+   </refsection>
+  </refentry>

Added: pear/peardoc/trunk/en/package/networking/net-ipv6/parseaddress.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ipv6/parseaddress.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/package/networking/net-ipv6/parseaddress.xml	2010-09-13 02:12:03 UTC (rev 303304)
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.networking.net-ipv6.parseaddress">
+   <refnamediv>
+    <refname>Net_IPv6::parseAddress()</refname>
+    <refpurpose>
+		Returns the lowest and highest IPv6 address for a given IP and netmask specification
+	</refpurpose>
+   </refnamediv>
+   <refsynopsisdiv>
+    <funcsynopsis>
+     <funcsynopsisinfo>
+      require_once 'Net/IPv6.php';
+     </funcsynopsisinfo>
+    <funcprototype>
+     <funcdef>string <function>Net_IPv6::parseAddress</function></funcdef>
+     <paramdef choice="req">string <parameter>$ipToParse</parameter></paramdef>
+     <paramdef choice="opt">int <parameter>$bits = null</parameter></paramdef>
+    </funcprototype>
+    </funcsynopsis>
+   </refsynopsisdiv>
+   <refsection xml:id="package.networking.net-ipv6.parseaddress.desc">
+    &title.desc;
+    <para>
+		Returns the lowest and highest IPv6 address for a given IP and netmask specification.
+	</para>
+	<para>
+		The netmask may be a part of the $ip or the number of netwask bits is provided via $bits.
+	</para>
+	<para>
+		The result is an indexed array. The key 'start' contains the lowest possible IP adress.
+		The key 'end' the highest address.
+    </para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.parseaddress.parameter">
+    &title.param;
+    <para>
+     <itemizedlist>
+      <listitem>
+       <para>
+        <parameter>string $ipToParse</parameter> -  the IP address in Hex format, compressed IPs are allowed
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>int $bits</parameter> -  if the number of netmask bits is not part of the IP, you must provide the mumber of bits
+       </para>
+      </listitem>
+     </itemizedlist>
+    </para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.parseaddress.return">
+    &title.returns;
+    <para>
+     <parameter>array</parameter> - the key 'start' contains the lowest possible IP adress.
+		The key 'end' the highest address.
+    </para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.parseaddress.note">
+    &title.note;
+    &note.canstatic;
+    <simpara>
+     Method available since: Release 1.1.0
+    </simpara>
+   </refsection>
+  </refentry>

Added: pear/peardoc/trunk/en/package/networking/net-ipv6/removeprefixlength.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ipv6/removeprefixlength.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/package/networking/net-ipv6/removeprefixlength.xml	2010-09-13 02:12:03 UTC (rev 303304)
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.networking.net-ipv6.removeprefixlength">
+   <refnamediv>
+    <refname>Net_IPv6::removePrefixLength()</refname>
+    <refpurpose>
+     Tests for a prefix length specification in the address and removes the prefix length, if exists.
+	</refpurpose>
+   </refnamediv>
+   <refsynopsisdiv>
+    <funcsynopsis>
+     <funcsynopsisinfo>
+      require_once 'Net/IPv6.php';
+     </funcsynopsisinfo>
+    <funcprototype>
+     <funcdef>string <function>Net_IPv6::removePrefixLength</function></funcdef>
+     <paramdef choice="req">string <parameter>$ip</parameter></paramdef>
+    </funcprototype>
+    </funcsynopsis>
+   </refsynopsisdiv>
+   <refsection xml:id="package.networking.net-ipv6.removeprefixlength.desc">
+    &title.desc;
+    <para>
+     Tests for a prefix length specification in the address and removes the prefix length, if exists.
+	</para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.removeprefixlength.parameter">
+    &title.param;
+    <para>
+     <itemizedlist>
+      <listitem>
+       <para>
+        <parameter>string $ip</parameter> -  the IP address in Hex format, compressed IPs are allowed
+       </para>
+      </listitem>
+     </itemizedlist>
+    </para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.removeprefixlength.return">
+    &title.returns;
+    <para>
+     <parameter>string</parameter> - the address without a prefix length.
+    </para>
+   </refsection>
+   <refsection xml:id="package.networking.net-ipv6.removeprefixlength.note">
+    &title.note;
+    &note.canstatic;
+    <simpara>
+     Method available since: Release 1.1.0
+    </simpara>
+   </refsection>
+  </refentry>

Modified: pear/peardoc/trunk/en/package/networking/net-ipv6.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ipv6.xml	2010-09-13 00:19:48 UTC (rev 303303)
+++ pear/peardoc/trunk/en/package/networking/net-ipv6.xml	2010-09-13 02:12:03 UTC (rev 303304)
@@ -16,8 +16,11 @@
  &package.networking.net-ipv6.uncompress;
  &package.networking.net-ipv6.getaddresstype;
  &package.networking.net-ipv6.getnetmask;
+ &package.networking.net-ipv6.getnetmaskspec;
+ &package.networking.net-ipv6.getprefixlength;
  &package.networking.net-ipv6.isinnetmask;
  &package.networking.net-ipv6.removenetmaskspec;
+ &package.networking.net-ipv6.removeprefixlength;
  &package.networking.net-ipv6.splitv64;

   </chapter>