documented

ircg_set_file
	ircg_get_username
	ircg_nickname_escape
	ircg_nickname_unescape


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@66576 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Georg Richter 2001-12-31 11:38:19 +00:00
parent 4933d0e8e3
commit 272e969b7b

View file

@ -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 @@ if (!ircg_join ($id, "#php")) {
</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 @@ if (!ircg_join ($id, "#php")) {
</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 @@ if (!ircg_join ($id, "#php")) {
</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 @@ if (!ircg_join ($id, "#php")) {
<refnamediv>
<refname>ircg_nickname_unescape</refname>
<refpurpose>
Decode encoded nickname
Decodes encoded nickname
</refpurpose>
</refnamediv>
<refsect1>
@ -739,7 +749,11 @@ if (!ircg_join ($id, "#php")) {
</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>