comparison src/log.h @ 10231:84cf3fc8a2cb

[gaim-migrate @ 11366] Doxygen updates from Andrew Hart. Thanks mang! committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Mon, 22 Nov 2004 04:58:57 +0000
parents 829a569993e0
children 64bc206c7473
comparison
equal deleted inserted replaced
10230:e76416d46af8 10231:84cf3fc8a2cb
77 GList *(*list)(GaimLogType type, const char *name, GaimAccount *account); 77 GList *(*list)(GaimLogType type, const char *name, GaimAccount *account);
78 78
79 /** Given one of the logs returned by the logger's list function, 79 /** Given one of the logs returned by the logger's list function,
80 * this returns the contents of the log in GtkIMHtml markup */ 80 * this returns the contents of the log in GtkIMHtml markup */
81 char *(*read)(GaimLog *log, GaimLogReadFlags *flags); 81 char *(*read)(GaimLog *log, GaimLogReadFlags *flags);
82 82
83 /** Given one of the logs returned by the logger's list function, 83 /** Given one of the logs returned by the logger's list function,
84 * this returns the size of the log in bytes */ 84 * this returns the size of the log in bytes */
85 int (*size)(GaimLog *log); 85 int (*size)(GaimLog *log);
86 86
87 /** Returns the total size of all the logs. If this is undefined a default 87 /** Returns the total size of all the logs. If this is undefined a default
110 110
111 #ifdef __cplusplus 111 #ifdef __cplusplus
112 extern "C" { 112 extern "C" {
113 #endif 113 #endif
114 114
115 /*************************************** 115 /***************************************/
116 ** LOG FUNCTIONS ********************** 116 /** @name Log Functions */
117 ***************************************/ 117 /***************************************/
118 /*@{*/
118 119
119 /** 120 /**
120 * Creates a new log 121 * Creates a new log
121 * 122 *
122 * @param type The type of log this is. 123 * @param type The type of log this is.
204 * @param y A GaimLog 205 * @param y A GaimLog
205 * @param z Another GaimLog 206 * @param z Another GaimLog
206 * @return A value as specified by GCompareFunc 207 * @return A value as specified by GCompareFunc
207 */ 208 */
208 gint gaim_log_compare(gconstpointer y, gconstpointer z); 209 gint gaim_log_compare(gconstpointer y, gconstpointer z);
209 210 /*@}*/
210 /****************************************** 211
211 ** LOGGER FUNCTIONS ********************** 212 /******************************************/
212 ******************************************/ 213 /** @name Logger Functions */
214 /******************************************/
215 /*@{*/
213 216
214 /** 217 /**
215 * Creates a new logger 218 * Creates a new logger
216 * 219 *
217 * @param create The logger's new function. 220 * @param create The logger's new function.
275 * @return The list of IDs and names. 278 * @return The list of IDs and names.
276 */ 279 */
277 GList *gaim_log_logger_get_options(void); 280 GList *gaim_log_logger_get_options(void);
278 281
279 void gaim_log_init(void); 282 void gaim_log_init(void);
280 /*@}*/ 283 /*@}*/
281 284
282 285
283 #ifdef __cplusplus 286 #ifdef __cplusplus
284 } 287 }
285 #endif 288 #endif