Comment updates.
authorPekka Riikonen <priikone@silcnet.org>
Sun, 26 Oct 2003 18:25:22 +0000 (18:25 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Sun, 26 Oct 2003 18:25:22 +0000 (18:25 +0000)
lib/silcclient/silcclient.h

index 49b23729ac490bd79758dcdae2e0af32b5b76624..7a99648dd88bed164488b4253a9443afe4bb1ae8 100644 (file)
@@ -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.
  *