hholzgra Sat Dec 15 09:44:24 2001 EDT
Modified files:
/phpdoc/en/functions ircg.xml
Log:
added skeletons for missing functions
Index: phpdoc/en/functions/ircg.xml
diff -u phpdoc/en/functions/ircg.xml:1.16 phpdoc/en/functions/ircg.xml:1.17
--- phpdoc/en/functions/ircg.xml:1.16 Wed Dec 12 15:46:59 2001
+++ phpdoc/en/functions/ircg.xml Sat Dec 15 09:44:23 2001
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.16 $ -->
+<!-- $Revision: 1.17 $ -->
<reference id="ref.ircg">
<title>IRC Gateway Functions</title>
<titleabbrev>IRC Gateway</titleabbrev>
@@ -631,6 +631,115 @@
</para>
<para>
See also: <function>ircg_lookup_format_messages</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id='function.ircg-set-on-die'>
+ <refnamediv>
+ <refname>ircg_set_on_die</refname>
+ <refpurpose>
+ Set hostaction to be execute when connection dies */
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>bool <function>ircg_set_on_die</function></funcdef>
+ <paramdef>int <parameter>connection</parameter></paramdef>
+ <paramdef>string <parameter>host</parameter></paramdef>
+ <paramdef>int <parameter>port</parameter></paramdef>
+ <paramdef>string <parameter>data</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id='function.ircg-set-file'>
+ <refnamediv>
+ <refname>ircg_set_file</refname>
+ <refpurpose>
+ Set logfile for connection
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>bool <function>ircg_set_file</function></funcdef>
+ <paramdef>int <parameter>connection</parameter></paramdef>
+ <paramdef>string <parameter>path</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id='function.ircg-get-username'>
+ <refnamediv>
+ <refname>ircg_get_username</refname>
+ <refpurpose>
+ Get username for connection
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ircg_get_username</function></funcdef>
+ <paramdef>int <parameter>connection</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id='function.ircg-nickname-escape'>
+ <refnamediv>
+ <refname>ircg_nickname_escape</refname>
+ <refpurpose>
+ Encode special characters in nickname to be IRC-compliant
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ircg_nickname_escape</function></funcdef>
+ <paramdef>string <parameter>nick</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id='function.ircg-nickname-unescape'>
+ <refnamediv>
+ <refname>ircg_nickname_escape</refname>
+ <refpurpose>
+ Decode encoded nickname
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ircg_nickname_escape</function></funcdef>
+ <paramdef>string <parameter>nick</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
</para>
</refsect1>
</refentry>
