From: Pekka Riikonen Date: Sun, 26 Oct 2003 18:25:22 +0000 (+0000) Subject: Comment updates. X-Git-Tag: silc.client.0.9.15~15 X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=commitdiff_plain;h=435e23abcd50c707a1714112be33ba45a4411d95 Comment updates. --- diff --git a/lib/silcclient/silcclient.h b/lib/silcclient/silcclient.h index 49b23729..7a99648d 100644 --- a/lib/silcclient/silcclient.h +++ b/lib/silcclient/silcclient.h @@ -1678,6 +1678,14 @@ SilcChannelUser silc_client_on_channel(SilcChannelEntry channel, * NULL); * silc_client_command_call(client, conn, "PING silc.silcnet.org"); * + * NOTES + * + * This command executes the commands implemented inside the client + * library. These commands are designed for command line applications, + * but GUI application may call them too if needed. Alternatively + * application may override the library and use silc_client_command_send + * function instead. + * ***/ bool silc_client_command_call(SilcClient client, SilcClientConnection conn, @@ -1702,6 +1710,10 @@ bool silc_client_command_call(SilcClient client, * Note that this overriders the Client Librarys commands and sends * the command packet directly to server. * + * Programmer should get familiar with the SILC protocol commands + * specification when using this function, as the arguments needs to + * be encoded as specified in the protocol. + * * The variable arguments are a pair of { type, data, data_length }, * and the `argc' is the number of these pairs. *