Mercurial > pidgin
changeset 9000:b540c735a6ad
[gaim-migrate @ 9775]
" There were a bunch of warnings while running make docs,
this cleans that up and adds documentation for gtkblist
signals, gtkconv signals, and gtkimhtml signals.
This patch is a tarball of the patch itself and the
three new files for the signal documentation." --Gary Kramlich
committer: Tailor Script <tailor@pidgin.im>
| author | Luke Schierer <lschiere@pidgin.im> |
|---|---|
| date | Fri, 21 May 2004 19:09:38 +0000 |
| parents | 8f838ae3e710 |
| children | 6bf49a1ec075 |
| files | ChangeLog doc/Makefile.am src/account.h src/blist.h src/log.h src/pluginpref.h src/prpl.h src/request.h src/roomlist.h src/util.h |
| diffstat | 10 files changed, 24 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- a/ChangeLog Fri May 21 14:33:32 2004 +0000 +++ b/ChangeLog Fri May 21 19:09:38 2004 +0000 @@ -43,6 +43,7 @@ * Direct IM for AIM should be slightly less buggy, and may actually work now, if at least one side isn't behind a NAT or firewall. * Made the recieve-*-msg signals match the sending ones (Stu Tomlinson) + * Documentation updates (Gary Kramlich, Stu Tomlinson) Preference Changes(Stu Tomlinson): * Added a "none" smiley theme to replace the "Show graphical
--- a/doc/Makefile.am Fri May 21 14:33:32 2004 +0000 +++ b/doc/Makefile.am Fri May 21 19:09:38 2004 +0000 @@ -10,7 +10,9 @@ blist-signals.dox \ connection-signals.dox \ conversation-signals.dox \ + gtkblist-signals.dox \ + gtkconv-signals.dox \ + gtkimhtml-signals.dox \ plugin-ids.dox \ gaim.1.in \ gaim-remote.1.in -
--- a/src/account.h Fri May 21 14:33:32 2004 +0000 +++ b/src/account.h Fri May 21 19:09:38 2004 +0000 @@ -528,7 +528,7 @@ * Returns the system log for an account. * Create it if it doesn't already exist. * - * @param gc The account. + * @param account The account. * * @return The log. */ @@ -537,7 +537,7 @@ /** * Frees the system log of an account * - * @param gc The account. + * @param account The account. */ void gaim_account_destroy_log(GaimAccount *account);
--- a/src/blist.h Fri May 21 14:33:32 2004 +0000 +++ b/src/blist.h Fri May 21 19:09:38 2004 +0000 @@ -703,6 +703,7 @@ * * @param account The account the buddy is added to. * @param group The optional group to add the chat to. + * @param alias The optional alias for the chat. */ void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, const char *alias);
--- a/src/log.h Fri May 21 14:33:32 2004 +0000 +++ b/src/log.h Fri May 21 19:09:38 2004 +0000 @@ -55,6 +55,7 @@ * This struct gets filled out and is included in the GaimLog. It contains everything * needed to write and read from logs. */ +/*@{*/ struct _GaimLogLogger { char *name; /**< The logger's name */ char *id; /**< an identifier to refer to this logger */ @@ -191,6 +192,7 @@ /** * Returns the size, in bytes, of all available logs in this conversation * + * @param type The type of the log * @param name The name of the log * @param account The account * @return The size in bytes @@ -284,4 +286,3 @@ #endif #endif /* _GAIM_LOG_H_ */ -
--- a/src/pluginpref.h Fri May 21 14:33:32 2004 +0000 +++ b/src/pluginpref.h Fri May 21 19:09:38 2004 +0000 @@ -201,8 +201,8 @@ /** * Set the max length for a string plugin pref * - * @param pref The plugin pref - * @param length The max length of the string + * @param pref The plugin pref + * @param max_length The max length of the string */ void gaim_plugin_pref_set_max_length(GaimPluginPref *pref, unsigned int max_length);
--- a/src/prpl.h Fri May 21 14:33:32 2004 +0000 +++ b/src/prpl.h Fri May 21 19:09:38 2004 +0000 @@ -355,7 +355,7 @@ /** * Finds a protocol plugin structure of the specified type. * - * @param type The protocol plugin; + * @param id The protocol plugin; */ GaimPlugin *gaim_find_prpl(const char *id);
--- a/src/request.h Fri May 21 14:33:32 2004 +0000 +++ b/src/request.h Fri May 21 19:09:38 2004 +0000 @@ -853,7 +853,7 @@ * Returns the data for a particular item. * * @param field The list field. - * @param item The item text. + * @param text The item text. * * @return The data associated with the item. */ @@ -1037,7 +1037,7 @@ * only online accounts will be shown. * * @param field The account field. - * @param show_all Whether or not to show all accounts. + * @return Whether or not to show all accounts. */ gboolean gaim_request_field_account_get_show_all( const GaimRequestField *field);
--- a/src/roomlist.h Fri May 21 14:33:32 2004 +0000 +++ b/src/roomlist.h Fri May 21 19:09:38 2004 +0000 @@ -219,10 +219,10 @@ * On some protocols, the rooms in the category * won't be fetched until this is called. * - * @param list The room list. - * @param room The category that was expanded. The expression - * (category->type & GAIM_ROOMLIST_ROOMTYPE_CATEGORY) - * must be true. + * @param list The room list. + * @param category The category that was expanded. The expression + * (category->type & GAIM_ROOMLIST_ROOMTYPE_CATEGORY) + * must be true. */ void gaim_roomlist_expand_category(GaimRoomlist *list, GaimRoomlistRoom *category); @@ -272,9 +272,10 @@ /** * Creates a new field. * - * @param type The type of the field. - * @param label The i18n'ed, user displayable name. - * @param name The internal name of the field. + * @param type The type of the field. + * @param label The i18n'ed, user displayable name. + * @param name The internal name of the field. + * @param hidden Hide the field. * * @return A new GaimRoomlistField, ready to be added to a GList and passed to * gaim_roomlist_set_fields().