georg Mon Dec 31 06:38:19 2001 EDT
Modified files:
/phpdoc/en/functions ircg.xml
Log:
documented
ircg_set_file
ircg_get_username
ircg_nickname_escape
ircg_nickname_unescape
Index: phpdoc/en/functions/ircg.xml
diff -u phpdoc/en/functions/ircg.xml:1.18 phpdoc/en/functions/ircg.xml:1.19
--- phpdoc/en/functions/ircg.xml:1.18 Sun Dec 30 17:26:40 2001
+++ phpdoc/en/functions/ircg.xml Mon Dec 31 06:38:19 2001
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.18 $ -->
+<!-- $Revision: 1.19 $ -->
<reference id="ref.ircg">
<title>IRC Gateway Functions</title>
<titleabbrev>IRC Gateway</titleabbrev>
@@ -676,7 +676,10 @@
</funcprototype>
</funcsynopsis>
<para>
- &warn.undocumented.func;
+ Function <function>ircg_set_file</function> specifies a logfile
+ <parameter>path</parameter> in which all output from connection
+ <parameter>connection</parameter> will be logged.
+ Returns &true; on success, otherwise &false;.
</para>
</refsect1>
</refentry>
@@ -697,7 +700,10 @@
</funcprototype>
</funcsynopsis>
<para>
- &warn.undocumented.func;
+ Function <function>ircg_get_username</function> returns the
+ username for specified connection <parameter>connection</parameter>.
+ Returns &false; if <parameter>connection</parameter> died or is
+ not valid.
</para>
</refsect1>
</refentry>
@@ -718,7 +724,11 @@
</funcprototype>
</funcsynopsis>
<para>
- &warn.undocumented.func;
+ Function <function>ircg_nickname_escape</function> returns a decoded
+ nickname specified by <parameter>nick</parameter> wich is IRC-compliant.
+ </para>
+ <para>
+ See also: <function>ircg_nickname_unescape</function>
</para>
</refsect1>
</refentry>
@@ -727,7 +737,7 @@
<refnamediv>
<refname>ircg_nickname_unescape</refname>
<refpurpose>
- Decode encoded nickname
+ Decodes encoded nickname
</refpurpose>
</refnamediv>
<refsect1>
@@ -739,7 +749,11 @@
</funcprototype>
</funcsynopsis>
<para>
- &warn.undocumented.func;
+ Function <function>ircg_nickname_unescape</function> returns a
+ decoded nickname, which is specified in <parameter>nick</parameter>.
+ </para>
+ <para>
+ See also: <function>ircg_nickname_escape</function>
</para>
</refsect1>
</refentry>
