Mercurial > pidgin
changeset 6488:e5e8d21bd4d8
[gaim-migrate @ 7002]
Some documentation updates. Really nothing great.
committer: Tailor Script <tailor@pidgin.im>
| author | Christian Hammond <chipx86@chipx86.com> |
|---|---|
| date | Mon, 18 Aug 2003 10:08:26 +0000 |
| parents | af83c7b6af00 |
| children | aefe4067d3a3 |
| files | Doxyfile.in src/connection.h src/conversation.h src/signals.c src/signals.h |
| diffstat | 5 files changed, 60 insertions(+), 21 deletions(-) [+] |
line wrap: on
line diff
--- a/Doxyfile.in Mon Aug 18 04:18:46 2003 +0000 +++ b/Doxyfile.in Mon Aug 18 10:08:26 2003 +0000 @@ -262,7 +262,7 @@ # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = +ALIASES = "signal=@xrefitem signal \"Signals\" \"Signals\" @b" # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif.
--- a/src/connection.h Mon Aug 18 04:18:46 2003 +0000 +++ b/src/connection.h Mon Aug 18 10:08:26 2003 +0000 @@ -19,6 +19,11 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * @signal signing-on (GaimConnection *gc) + * @signal signed-on (GaimConnection *gc) + * @signal signing-off (GaimConnection *gc) + * @signal signed-off (GaimConnection *gc) */ #ifndef _GAIM_CONNECTION_H_ #define _GAIM_CONNECTION_H_ @@ -94,6 +99,7 @@ /**************************************************************************/ /** @name Connection API */ /**************************************************************************/ +/*@{*/ /** * Creates a connection to the specified account. @@ -122,7 +128,7 @@ /** * Signs a connection off. - * + * @param gc The connection to sign off. * * @see gaim_connection_connect() @@ -233,23 +239,6 @@ */ GList *gaim_connections_get_connecting(void); -/** - * Initializes the connections subsystem. - */ -void gaim_connections_init(void); - -/** - * Uninitializes the connections subsystem. - */ -void gaim_connections_uninit(void); - -/** - * Returns the handle to the connections subsystem. - * - * @return The connections subsystem handle. - */ -void *gaim_connections_get_handle(void); - /*@}*/ /**************************************************************************/ @@ -273,6 +262,31 @@ /*@}*/ +/**************************************************************************/ +/** @name Connections Subsystem */ +/**************************************************************************/ +/*@{*/ + +/** + * Initializes the connections subsystem. + */ +void gaim_connections_init(void); + +/** + * Uninitializes the connections subsystem. + */ +void gaim_connections_uninit(void); + +/** + * Returns the handle to the connections subsystem. + * + * @return The connections subsystem handle. + */ +void *gaim_connections_get_handle(void); + +/*@}*/ + + #ifdef __cplusplus } #endif
--- a/src/conversation.h Mon Aug 18 04:18:46 2003 +0000 +++ b/src/conversation.h Mon Aug 18 10:08:26 2003 +0000 @@ -19,6 +19,31 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * @signal displaying-im-msg + * @signal displayed-im-msg + * @signal sending-im-msg + * @signal sent-im-msg + * @signal received-im-msg + * @signal displaying-chat-msg + * @signal displayed-chat-msg + * @signal sending-chat-msg + * @signal sent-chat-msg + * @signal received-chat-msg + * @signal conversation-switching + * @signal conversation-switched + * @signal conversation-created + * @signal deleting-conversation + * @signal buddy-typing + * @signal chat-buddy-joining + * @signal chat-buddy-joined + * @signal chat-buddy-leaving + * @signal chat-buddy-left + * @signal chat-inviting-user + * @signal chat-invited-user + * @signal chat-invited + * @signal chat-joined + * @signal chat-left */ #ifndef _GAIM_CONVERSATION_H_ #define _GAIM_CONVERSATION_H_