--- a/libpurple/whiteboard.h Fri Jan 31 17:56:27 2014 +0530
+++ b/libpurple/whiteboard.h Fri Jan 31 18:14:33 2014 +0530
@@ -127,231 +127,231 @@
/**
* Sets the UI operations
*
- * @param ops The UI operations to set
+ * @ops: The UI operations to set
*/
void purple_whiteboard_set_ui_ops(PurpleWhiteboardUiOps *ops);
/**
* Sets the prpl operations for a whiteboard
*
- * @param wb The whiteboard for which to set the prpl operations
- * @param ops The prpl operations to set
+ * @wb: The whiteboard for which to set the prpl operations
+ * @ops: The prpl operations to set
*/
void purple_whiteboard_set_prpl_ops(PurpleWhiteboard *wb, PurpleWhiteboardPrplOps *ops);
/**
* Creates a new whiteboard
*
- * @param account The account.
- * @param who Who you're drawing with.
- * @param state The state.
+ * @account: The account.
+ * @who: Who you're drawing with.
+ * @state: The state.
*
- * @return The new whiteboard
+ * Returns: The new whiteboard
*/
PurpleWhiteboard *purple_whiteboard_new(PurpleAccount *account, const char *who, int state);
/**
* Returns the whiteboard's account.
*
- * @param wb The whiteboard.
+ * @wb: The whiteboard.
*
- * @return The whiteboard's account.
+ * Returns: The whiteboard's account.
*/
PurpleAccount *purple_whiteboard_get_account(const PurpleWhiteboard *wb);
/**
* Return who you're drawing with.
*
- * @param wb The whiteboard
+ * @wb: The whiteboard
*
- * @return Who you're drawing with.
+ * Returns: Who you're drawing with.
*/
const char *purple_whiteboard_get_who(const PurpleWhiteboard *wb);
/**
* Set the state of the whiteboard.
*
- * @param wb The whiteboard.
- * @param state The state
+ * @wb: The whiteboard.
+ * @state: The state
*/
void purple_whiteboard_set_state(PurpleWhiteboard *wb, int state);
/**
* Return the state of the whiteboard.
*
- * @param wb The whiteboard.
+ * @wb: The whiteboard.
*
- * @return The state of the whiteboard.
+ * Returns: The state of the whiteboard.
*/
int purple_whiteboard_get_state(const PurpleWhiteboard *wb);
/**
* Starts a whiteboard
*
- * @param wb The whiteboard.
+ * @wb: The whiteboard.
*/
void purple_whiteboard_start(PurpleWhiteboard *wb);
/**
* Finds a whiteboard from an account and user.
*
- * @param account The account.
- * @param who The user.
+ * @account: The account.
+ * @who: The user.
*
- * @return The whiteboard if found, otherwise @c NULL.
+ * Returns: The whiteboard if found, otherwise %NULL.
*/
PurpleWhiteboard *purple_whiteboard_get_session(const PurpleAccount *account, const char *who);
/**
* Destorys a drawing list for a whiteboard
*
- * @param draw_list The drawing list.
+ * @draw_list: The drawing list.
*/
void purple_whiteboard_draw_list_destroy(GList *draw_list);
/**
* Gets the dimension of a whiteboard.
*
- * @param wb The whiteboard.
- * @param width The width to be set.
- * @param height The height to be set.
+ * @wb: The whiteboard.
+ * @width: The width to be set.
+ * @height: The height to be set.
*
- * @return TRUE if the values of width and height were set.
+ * Returns: TRUE if the values of width and height were set.
*/
gboolean purple_whiteboard_get_dimensions(const PurpleWhiteboard *wb, int *width, int *height);
/**
* Sets the dimensions for a whiteboard.
*
- * @param wb The whiteboard.
- * @param width The width.
- * @param height The height.
+ * @wb: The whiteboard.
+ * @width: The width.
+ * @height: The height.
*/
void purple_whiteboard_set_dimensions(PurpleWhiteboard *wb, int width, int height);
/**
* Draws a point on a whiteboard.
*
- * @param wb The whiteboard.
- * @param x The x coordinate.
- * @param y The y coordinate.
- * @param color The color to use.
- * @param size The brush size.
+ * @wb: The whiteboard.
+ * @x: The x coordinate.
+ * @y: The y coordinate.
+ * @color: The color to use.
+ * @size: The brush size.
*/
void purple_whiteboard_draw_point(PurpleWhiteboard *wb, int x, int y, int color, int size);
/**
* Send a list of points to draw to the buddy.
*
- * @param wb The whiteboard
- * @param list A GList of points
+ * @wb: The whiteboard
+ * @list: A GList of points
*/
void purple_whiteboard_send_draw_list(PurpleWhiteboard *wb, GList *list);
/**
* Draws a line on a whiteboard
*
- * @param wb The whiteboard.
- * @param x1 The top-left x coordinate.
- * @param y1 The top-left y coordinate.
- * @param x2 The bottom-right x coordinate.
- * @param y2 The bottom-right y coordinate.
- * @param color The color to use.
- * @param size The brush size.
+ * @wb: The whiteboard.
+ * @x1: The top-left x coordinate.
+ * @y1: The top-left y coordinate.
+ * @x2: The bottom-right x coordinate.
+ * @y2: The bottom-right y coordinate.
+ * @color: The color to use.
+ * @size: The brush size.
*/
void purple_whiteboard_draw_line(PurpleWhiteboard *wb, int x1, int y1, int x2, int y2, int color, int size);
/**
* Clears a whiteboard
*
- * @param wb The whiteboard.
+ * @wb: The whiteboard.
*/
void purple_whiteboard_clear(PurpleWhiteboard *wb);
/**
* Sends a request to the buddy to clear the whiteboard.
*
- * @param wb The whiteboard
+ * @wb: The whiteboard
*/
void purple_whiteboard_send_clear(PurpleWhiteboard *wb);
/**
* Sends a request to change the size and color of the brush.
*
- * @param wb The whiteboard
- * @param size The size of the brush
- * @param color The color of the brush
+ * @wb: The whiteboard
+ * @size: The size of the brush
+ * @color: The color of the brush
*/
void purple_whiteboard_send_brush(PurpleWhiteboard *wb, int size, int color);
/**
* Gets the size and color of the brush.
*
- * @param wb The whiteboard
- * @param size The size of the brush
- * @param color The color of the brush
+ * @wb: The whiteboard
+ * @size: The size of the brush
+ * @color: The color of the brush
*
- * @return TRUE if the size and color were set.
+ * Returns: TRUE if the size and color were set.
*/
gboolean purple_whiteboard_get_brush(const PurpleWhiteboard *wb, int *size, int *color);
/**
* Sets the size and color of the brush.
*
- * @param wb The whiteboard
- * @param size The size of the brush
- * @param color The color of the brush
+ * @wb: The whiteboard
+ * @size: The size of the brush
+ * @color: The color of the brush
*/
void purple_whiteboard_set_brush(PurpleWhiteboard *wb, int size, int color);
/**
* Return the drawing list.
*
- * @param wb The whiteboard.
+ * @wb: The whiteboard.
*
- * @return The drawing list
+ * Returns: The drawing list
*/
GList *purple_whiteboard_get_draw_list(const PurpleWhiteboard *wb);
/**
* Set the drawing list.
*
- * @param wb The whiteboard
- * @param draw_list The drawing list.
+ * @wb: The whiteboard
+ * @draw_list: The drawing list.
*/
void purple_whiteboard_set_draw_list(PurpleWhiteboard *wb, GList* draw_list);
/**
* Sets the protocol data for a whiteboard.
*
- * @param wb The whiteboard.
- * @param proto_data The protocol data to set for the whiteboard.
+ * @wb: The whiteboard.
+ * @proto_data: The protocol data to set for the whiteboard.
*/
void purple_whiteboard_set_protocol_data(PurpleWhiteboard *wb, gpointer proto_data);
/**
* Gets the protocol data for a whiteboard.
*
- * @param wb The whiteboard.
+ * @wb: The whiteboard.
*
- * @return The protocol data for the whiteboard.
+ * Returns: The protocol data for the whiteboard.
*/
gpointer purple_whiteboard_get_protocol_data(const PurpleWhiteboard *wb);
/**
* Set the UI data associated with this whiteboard.
*
- * @param wb The whiteboard.
- * @param ui_data A pointer to associate with this whiteboard.
+ * @wb: The whiteboard.
+ * @ui_data: A pointer to associate with this whiteboard.
*/
void purple_whiteboard_set_ui_data(PurpleWhiteboard *wb, gpointer ui_data);
/**
* Get the UI data associated with this whiteboard.
*
- * @param wb The whiteboard..
+ * @wb: The whiteboard..
*
- * @return The UI data associated with this whiteboard. This is a
+ * Returns: The UI data associated with this whiteboard. This is a
* convenience field provided to the UIs--it is not
* used by the libpurple core.
*/
