svn: /pear/peardoc/trunk/en/package/ mail/mail/factory.xml networking/net-smtp/intro.xml networking/net-smtp/setdebug.xml

cweiske                                  Thu, 27 Aug 2009 05:29:37 +0000

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

Log:
interlink net_smtp::setdebug from mail::factory - a user in #pear had problems with that link missing

Changed paths:
    U   pear/peardoc/trunk/en/package/mail/mail/factory.xml
    U   pear/peardoc/trunk/en/package/networking/net-smtp/intro.xml
    U   pear/peardoc/trunk/en/package/networking/net-smtp/setdebug.xml

Modified: pear/peardoc/trunk/en/package/mail/mail/factory.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail/factory.xml	2009-08-27 05:05:42 UTC (rev 287790)
+++ pear/peardoc/trunk/en/package/mail/mail/factory.xml	2009-08-27 05:29:37 UTC (rev 287791)
@@ -144,6 +144,12 @@
             <parameter>$params["debug"]</parameter> - Whether to enable SMTP
             debug mode or not. Default is &false;.
            </para>
+           <para>
+            <classname>Mail</classname> internally uses
+            <link linkend="package.networking.net-smtp.net-smtp.setdebug">
+             <literal>Net_SMTP::setDebug</literal>
+            </link>.
+           </para>
           </listitem>
           <listitem>
            <para>

Modified: pear/peardoc/trunk/en/package/networking/net-smtp/intro.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-smtp/intro.xml	2009-08-27 05:05:42 UTC (rev 287790)
+++ pear/peardoc/trunk/en/package/networking/net-smtp/intro.xml	2009-08-27 05:29:37 UTC (rev 287791)
@@ -53,8 +53,8 @@
    </refsection>


-   <refsection><info><title>Error Handling</title></info>
-
+   <refsection xml:id="package.networking.net-smtp.intro.errorhandling">
+    <info><title>Error Handling</title></info>

     <para>
      All of the <classname>Net_SMTP</classname> class's public methods return a
@@ -203,7 +203,8 @@
    </refsection>


-   <refsection><info><title>Debugging</title></info>
+   <refsection xml:id="package.networking.net-smtp.intro.debugging">
+    <info><title>Debugging</title></info>


     <para>

Modified: pear/peardoc/trunk/en/package/networking/net-smtp/setdebug.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-smtp/setdebug.xml	2009-08-27 05:05:42 UTC (rev 287790)
+++ pear/peardoc/trunk/en/package/networking/net-smtp/setdebug.xml	2009-08-27 05:29:37 UTC (rev 287791)
@@ -12,23 +12,33 @@
      <funcprototype>
       <funcdef>void<function>Net_SMTP::setDebug</function></funcdef>
       <paramdef choice="req">boolean <parameter>$debug</parameter></paramdef>
+      <paramdef choice="opt">callback <parameter>$handler</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
-    </refsynopsisdiv>
-    <refsection xml:id="package.networking.net-smtp.net-smtp.setdebug.desc">
+   </refsynopsisdiv>
+
+   <refsection xml:id="package.networking.net-smtp.net-smtp.setdebug.desc">
      &title.desc;
-      <para>
-      Set the value of the debugging flag.
-        </para>
-    </refsection>
+     <para>
+      Enables or disables debugging.
+      Once debugging is enabled, messages preceded by
+      "<literal>DEBUG: </literal>" are being echoed out.
+     </para>
+     <para>
+      See also
+      <link linkend="package.networking.net-smtp.intro.debugging">
+	Debugging introduction
+      </link>
+     </para>
+   </refsection>
+
    <refsection xml:id="package.networking.net-smtp.net-smtp.setdebug.param">
     &title.param;
     <para>
      <variablelist>
       <varlistentry>
        <term>
-         &type.bool;
-      <parameter>$debug</parameter>
+         &type.bool; <parameter>$debug</parameter>
        </term>
        <listitem>
         <para>
@@ -36,15 +46,30 @@
         </para>
        </listitem>
       </varlistentry>
+
+      <varlistentry>
+       <term>
+         &type.callback; <parameter>$handler</parameter>
+       </term>
+       <listitem>
+        <para>
+         Callback function that gets called with Net_SMTP object
+	 and message to display.
+        </para>
+       </listitem>
+      </varlistentry>
+
      </variablelist>
     </para>
    </refsection>
+
    <refsection xml:id="package.networking.net-smtp.net-smtp.setdebug.throws">
     &title.throws;
-        <para>
+    <para>
       <emphasis>throws</emphasis> no exceptions thrown
     </para>
-       </refsection>
+   </refsection>
+
    <refsection xml:id="package.networking.net-smtp.net-smtp.setdebug.note">
     &title.note;
     &note.notstatic;