[asterisk-commits] oej: trunk r56623 - in /trunk/include/asterisk: doxyref.h jabber.h

[asterisk-commits at lists.digium.com]

Author: oej
Date: Sat Feb 24 11:51:23 2007
New Revision: 56623

URL: http://svn.digium.com/view/asterisk?view=rev&rev=56623
Log:
Doxygen updates for AJI - The Asterisk Jabber API

Modified:
    trunk/include/asterisk/doxyref.h
    trunk/include/asterisk/jabber.h

Modified: trunk/include/asterisk/doxyref.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/doxyref.h?view=diff&rev=56623&r1=56622&r2=56623
==============================================================================
--- trunk/include/asterisk/doxyref.h (original)
+++ trunk/include/asterisk/doxyref.h Sat Feb 24 11:51:23 2007
@@ -33,6 +33,7 @@
  *  \arg \ref AstAMI : The Call management socket API
  *  \arg \ref AstARA : A generic data storage and retrieval API for Asterisk
  *  \arg \ref AstDUNDi : A way to find phone services dynamically by using the DUNDi protocol
+ *  \arg \ref AJI_intro : The Asterisk Jabber Interface
  *  \arg \ref AstCDR
  *  \arg \ref AstREADME
  *  \arg \ref AstVar

Modified: trunk/include/asterisk/jabber.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/jabber.h?view=diff&rev=56623&r1=56622&r2=56623
==============================================================================
--- trunk/include/asterisk/jabber.h (original)
+++ trunk/include/asterisk/jabber.h Sat Feb 24 11:51:23 2007
@@ -14,6 +14,26 @@
  * This program is free software, distributed under the terms of
  * the GNU General Public License Version 2. See the LICENSE file
  * at the top of the source tree.
+ */
+
+/*! \file
+ * \brief AJI - The Asterisk Jabber Interface
+ * \ref AJI_intro
+ * \ref res_jabber.c
+ * \author Matt O'Gorman <mogorman at digium.com>
+ *
+ * \page AJI_intro AJI - The Asterisk Jabber Interface
+ * 
+ * The Asterisk Jabber Interface, AJI, publishes an API for
+ * modules to use jabber communication. res_jabber.c implements
+ * a Jabber client and a component that can connect as a service
+ * to Jabber servers.
+ *
+ * See
+ * - res_jabber.c
+ * - jabber.h
+ * - chan_gtalk.c
+ *
  */
 
 #ifndef _ASTERISK_JABBER_H
@@ -122,12 +142,17 @@
 	ASTOBJ_CONTAINER_COMPONENTS(struct aji_client);
 };
 
+/*! Send jabber message from connected client to jabber URI */
 int ast_aji_send(struct aji_client *client, const char *address, const char *message);
+/*! Disconnect jabber client */
 int ast_aji_disconnect(struct aji_client *client);
 int ast_aji_check_roster(void);
 void ast_aji_increment_mid(char *mid);
+/*! Open Chat session */
 int ast_aji_create_chat(struct aji_client *client,char *room, char *server, char *topic);
+/*! Invite to opened Chat session */
 int ast_aji_invite_chat(struct aji_client *client, char *user, char *room, char *message);
+/*! Join existing Chat session */
 int ast_aji_join_chat(struct aji_client *client,char *room);
 struct aji_client *ast_aji_get_client(const char *name);
 struct aji_client_container *ast_aji_get_clients(void);