Mercurial > pidgin.yaz
comparison libpurple/roomlist.h @ 32687:02a2e8183b1d
Clean the API documentation in preparation for 3.0.0 by removing all the old @since tags.
author | andrew.victor@mxit.com |
---|---|
date | Sun, 25 Sep 2011 18:56:58 +0000 |
parents | 5aa171c8776b |
children |
comparison
equal
deleted
inserted
replaced
32685:9d5b87e1a4d0 | 32687:02a2e8183b1d |
---|---|
215 /** | 215 /** |
216 * Get the list of fields for a roomlist. | 216 * Get the list of fields for a roomlist. |
217 * | 217 * |
218 * @param roomlist The roomlist, which must not be @c NULL. | 218 * @param roomlist The roomlist, which must not be @c NULL. |
219 * @constreturn A list of fields | 219 * @constreturn A list of fields |
220 * @since 2.4.0 | |
221 */ | 220 */ |
222 GList *purple_roomlist_get_fields(PurpleRoomlist *roomlist); | 221 GList *purple_roomlist_get_fields(PurpleRoomlist *roomlist); |
223 | 222 |
224 /** | 223 /** |
225 * Get the protocol data associated with this room list. | 224 * Get the protocol data associated with this room list. |
297 | 296 |
298 /** | 297 /** |
299 * Get the type of a room. | 298 * Get the type of a room. |
300 * @param room The room, which must not be @c NULL. | 299 * @param room The room, which must not be @c NULL. |
301 * @return The type of the room. | 300 * @return The type of the room. |
302 * @since 2.4.0 | |
303 */ | 301 */ |
304 PurpleRoomlistRoomType purple_roomlist_room_get_type(PurpleRoomlistRoom *room); | 302 PurpleRoomlistRoomType purple_roomlist_room_get_type(PurpleRoomlistRoom *room); |
305 | 303 |
306 /** | 304 /** |
307 * Get the name of a room. | 305 * Get the name of a room. |
308 * @param room The room, which must not be @c NULL. | 306 * @param room The room, which must not be @c NULL. |
309 * @return The name of the room. | 307 * @return The name of the room. |
310 * @since 2.4.0 | |
311 */ | 308 */ |
312 const char * purple_roomlist_room_get_name(PurpleRoomlistRoom *room); | 309 const char * purple_roomlist_room_get_name(PurpleRoomlistRoom *room); |
313 | 310 |
314 /** | 311 /** |
315 * Get the parent of a room. | 312 * Get the parent of a room. |
316 * @param room The room, which must not be @c NULL. | 313 * @param room The room, which must not be @c NULL. |
317 * @return The parent of the room, which can be @c NULL. | 314 * @return The parent of the room, which can be @c NULL. |
318 * @since 2.4.0 | |
319 */ | 315 */ |
320 PurpleRoomlistRoom * purple_roomlist_room_get_parent(PurpleRoomlistRoom *room); | 316 PurpleRoomlistRoom * purple_roomlist_room_get_parent(PurpleRoomlistRoom *room); |
321 | 317 |
322 /** | 318 /** |
323 * Get the value of the expanded_once flag. | 319 * Get the value of the expanded_once flag. |
339 /** | 335 /** |
340 * Get the list of fields for a room. | 336 * Get the list of fields for a room. |
341 * | 337 * |
342 * @param room The room, which must not be @c NULL. | 338 * @param room The room, which must not be @c NULL. |
343 * @constreturn A list of fields | 339 * @constreturn A list of fields |
344 * @since 2.4.0 | |
345 */ | 340 */ |
346 GList * purple_roomlist_room_get_fields(PurpleRoomlistRoom *room); | 341 GList * purple_roomlist_room_get_fields(PurpleRoomlistRoom *room); |
347 | 342 |
348 /*@}*/ | 343 /*@}*/ |
349 | 344 |
371 * Get the type of a field. | 366 * Get the type of a field. |
372 * | 367 * |
373 * @param field A PurpleRoomlistField, which must not be @c NULL. | 368 * @param field A PurpleRoomlistField, which must not be @c NULL. |
374 * | 369 * |
375 * @return The type of the field. | 370 * @return The type of the field. |
376 * @since 2.4.0 | |
377 */ | 371 */ |
378 PurpleRoomlistFieldType purple_roomlist_field_get_type(PurpleRoomlistField *field); | 372 PurpleRoomlistFieldType purple_roomlist_field_get_type(PurpleRoomlistField *field); |
379 | 373 |
380 /** | 374 /** |
381 * Get the label of a field. | 375 * Get the label of a field. |
382 * | 376 * |
383 * @param field A PurpleRoomlistField, which must not be @c NULL. | 377 * @param field A PurpleRoomlistField, which must not be @c NULL. |
384 * | 378 * |
385 * @return The label of the field. | 379 * @return The label of the field. |
386 * @since 2.4.0 | |
387 */ | 380 */ |
388 const char * purple_roomlist_field_get_label(PurpleRoomlistField *field); | 381 const char * purple_roomlist_field_get_label(PurpleRoomlistField *field); |
389 | 382 |
390 /** | 383 /** |
391 * Check whether a roomlist-field is hidden. | 384 * Check whether a roomlist-field is hidden. |
392 * @param field A PurpleRoomlistField, which must not be @c NULL. | 385 * @param field A PurpleRoomlistField, which must not be @c NULL. |
393 * | 386 * |
394 * @return @c TRUE if the field is hidden, @c FALSE otherwise. | 387 * @return @c TRUE if the field is hidden, @c FALSE otherwise. |
395 * @since 2.4.0 | |
396 */ | 388 */ |
397 gboolean purple_roomlist_field_get_hidden(PurpleRoomlistField *field); | 389 gboolean purple_roomlist_field_get_hidden(PurpleRoomlistField *field); |
398 | 390 |
399 /*@}*/ | 391 /*@}*/ |
400 | 392 |