GUAC-1389: Bring common headers up-to-date with current style.

src/common/guac_cursor.h

@@ -112,15 +112,19 @@ typedef struct guac_common_cursor {
  * Allocates a new cursor object which maintains and synchronizes the current
  * mouse cursor state across all users of the given client.
  *
- * @param client The client for which this object shall maintain the mouse
+ * @param client
- *               cursor.
+ *     The client for which this object shall maintain the mouse cursor.
+ *
+ * @return
+ *     The newly-allocated mouse cursor.
  */
 guac_common_cursor* guac_common_cursor_alloc(guac_client* client);
 
 /**
  * Frees the given cursor.
  *
- * @param cursor The cursor to free.
+ * @param cursor
+ *     The cursor to free.
  */
 void guac_common_cursor_free(guac_common_cursor* cursor);
 
@@ -146,10 +150,17 @@ void guac_common_cursor_dup(guac_common_cursor* cursor, guac_user* user,
  * the mouse. The remote mouse cursor will be hidden for this user and shown
  * for all others.
  *
- * @param cursor The cursor being moved.
+ * @param cursor
- * @param user The user that moved the cursor.
+ *     The cursor being moved.
- * @param x The new X coordinate of the cursor.
+ *
- * @param y The new Y coordinate of the cursor.
+ * @param user
+ *     The user that moved the cursor.
+ *
+ * @param x
+ *     The new X coordinate of the cursor.
+ *
+ * @param y
+ *     The new Y coordinate of the cursor.
  */
 void guac_common_cursor_move(guac_common_cursor* cursor, guac_user* user,
         int x, int y);
@@ -160,13 +171,26 @@ void guac_common_cursor_move(guac_common_cursor* cursor, guac_user* user,
  * alpha component is stored in the high-order 8 bits, and blue is stored
  * in the low-order 8 bits.
  *
- * @param cursor The cursor to set the image of.
+ * @param cursor
- * @param hx The X coordinate of the hotspot of the new cursor image.
+ *     The cursor to set the image of.
- * @param hy The Y coordinate of the hotspot of the new cursor image.
+ *
- * @param data A pointer to raw 32-bit ARGB image data.
+ * @param hx
- * @param width The width of the given image data, in pixels.
+ *     The X coordinate of the hotspot of the new cursor image.
- * @param height The height of the given image data, in pixels.
+ *
- * @param stride The number of bytes in a single row of image data.
+ * @param hy
+ *     The Y coordinate of the hotspot of the new cursor image.
+ *
+ * @param data
+ *     A pointer to raw 32-bit ARGB image data.
+ *
+ * @param width
+ *     The width of the given image data, in pixels.
+ *
+ * @param height
+ *     The height of the given image data, in pixels.
+ *
+ * @param stride
+ *     The number of bytes in a single row of image data.
  */
 void guac_common_cursor_set_argb(guac_common_cursor* cursor, int hx, int hy,
     unsigned const char* data, int width, int height, int stride);
@@ -176,10 +200,17 @@ void guac_common_cursor_set_argb(guac_common_cursor* cursor, int hx, int hy,
  * contents of the surface are used, and the dimensions of the resulting
  * cursor will be the dimensions of the given surface.
  *
- * @param cursor The cursor to set the image of.
+ * @param cursor
- * @param hx The X coordinate of the hotspot of the new cursor image.
+ *     The cursor to set the image of.
- * @param hy The Y coordinate of the hotspot of the new cursor image.
+ *
- * @param surface The surface containing the cursor image.
+ * @param hx
+ *     The X coordinate of the hotspot of the new cursor image.
+ *
+ * @param hy
+ *     The Y coordinate of the hotspot of the new cursor image.
+ *
+ * @param surface
+ *     The surface containing the cursor image.
  */
 void guac_common_cursor_set_surface(guac_common_cursor* cursor, int hx, int hy,
     guac_common_surface* surface);
@@ -188,7 +219,8 @@ void guac_common_cursor_set_surface(guac_common_cursor* cursor, int hx, int hy,
  * Set the cursor of the remote display to the embedded "pointer" graphic. The
  * pointer graphic is a black arrow with white border.
  *
- * @param cursor The cursor to set the image of.
+ * @param cursor
+ *     The cursor to set the image of.
  */
 void guac_common_cursor_set_pointer(guac_common_cursor* cursor);
 
@@ -196,7 +228,8 @@ void guac_common_cursor_set_pointer(guac_common_cursor* cursor);
  * Set the cursor of the remote display to the embedded "dot" graphic. The dot
  * graphic is a small black square with white border.
  *
- * @param cursor The cursor to set the image of.
+ * @param cursor
+ *     The cursor to set the image of.
  */
 void guac_common_cursor_set_dot(guac_common_cursor* cursor);
 
@@ -225,8 +258,11 @@ void guac_common_cursor_set_blank(guac_common_cursor* cursor);
  * connection and this is not called, the corresponding guac_user and socket
  * may cease to be valid, and future synchronization attempts will segfault.
  *
- * @param cursor The cursor to remove the user from.
+ * @param cursor
- * @param user The user to remove.
+ *     The cursor to remove the user from.
+ *
+ * @param user
+ *     The user to remove.
  */
 void guac_common_cursor_remove_user(guac_common_cursor* cursor,
         guac_user* user);

src/common/guac_display.h

@@ -107,10 +107,17 @@ typedef struct guac_common_display {
  * operations of the given guac_client such that client state can be easily
  * synchronized to joining users.
  *
- * @param client The guac_client to associate with this display.
+ * @param client
- * @param width The initial width of the display, in pixels.
+ *     The guac_client to associate with this display.
- * @param height The initial height of the display, in pixels.
+ *
- * @return The newly-allocated display.
+ * @param width
+ *     The initial width of the display, in pixels.
+ *
+ * @param height
+ *     The initial height of the display, in pixels.
+ *
+ * @return
+ *     The newly-allocated display.
  */
 guac_common_display* guac_common_display_alloc(guac_client* client,
         int width, int height);
@@ -119,7 +126,8 @@ guac_common_display* guac_common_display_alloc(guac_client* client,
  * Frees the given display, and any associated resources, including any
  * allocated buffers/layers.
  *
- * @param display The display to free.
+ * @param display
+ *     The display to free.
  */
 void guac_common_display_free(guac_common_display* display);
 
@@ -143,7 +151,8 @@ void guac_common_display_dup(guac_common_display* display, guac_user* user,
  * Flushes pending changes to the given display. All pending operations will
  * become visible to any connected users.
  *
- * @param display The display to flush.
+ * @param display
+ *     The display to flush.
  */
 void guac_common_display_flush(guac_common_display* display);
 
@@ -152,10 +161,17 @@ void guac_common_display_flush(guac_common_display* display);
  * surface. The layer may be reused from a previous allocation, if that layer
  * has since been freed.
  *
- * @param display The display to allocate a new layer from.
+ * @param display
- * @param width The width of the layer to allocate, in pixels.
+ *     The display to allocate a new layer from.
- * @param height The height of the layer to allocate, in pixels.
+ *
- * @return A newly-allocated layer.
+ * @param width
+ *     The width of the layer to allocate, in pixels.
+ *
+ * @param height
+ *     The height of the layer to allocate, in pixels.
+ *
+ * @return
+ *     A newly-allocated layer.
  */
 guac_common_display_layer* guac_common_display_alloc_layer(
         guac_common_display* display, int width, int height);
@@ -165,10 +181,17 @@ guac_common_display_layer* guac_common_display_alloc_layer(
  * surface. The buffer may be reused from a previous allocation, if that buffer
  * has since been freed.
  *
- * @param display The display to allocate a new buffer from.
+ * @param display
- * @param width The width of the buffer to allocate, in pixels.
+ *     The display to allocate a new buffer from.
- * @param height The height of the buffer to allocate, in pixels.
+ *
- * @return A newly-allocated buffer.
+ * @param width
+ *     The width of the buffer to allocate, in pixels.
+ *
+ * @param height
+ *     The height of the buffer to allocate, in pixels.
+ *
+ * @return
+ *     A newly-allocated buffer.
  */
 guac_common_display_layer* guac_common_display_alloc_buffer(
         guac_common_display* display, int width, int height);