doxygen docs: Adapt to Doxygen syntax

I don't know where did these comments come from, but it was not Doxygen.

diff --git a/src/lib/ecore_wayland/ivi-application-client-protocol.h b/src/lib/ecore_wayland/ivi-application-client-protocol.h
index 84fecd8..7f82577 100644 (file)
--- a/src/lib/ecore_wayland/ivi-application-client-protocol.h
+++ b/src/lib/ecore_wayland/ivi-application-client-protocol.h
@@ -44,59 +44,45 @@ extern const struct wl_interface ivi_application_interface;
 #ifndef IVI_SURFACE_WARNING_CODE_ENUM
 #define IVI_SURFACE_WARNING_CODE_ENUM
 /**
- * ivi_surface_warning_code - possible warning codes returned by ivi
- *      compositor
- * @IVI_SURFACE_WARNING_CODE_INVALID_WL_SURFACE: wl_surface is invalid
- * @IVI_SURFACE_WARNING_CODE_IVI_ID_IN_USE: ivi_id is in use and can not
- *      be shared
+ * @brief Possible warning codes returned by ivi compositor
  *
  * These define all possible warning codes returned by ivi compositor on
- * server-side warnings. invalid_wl_surface: - wl_surface already has a
- * another role. - wl_surface is destroyed before the ivi_surface is
- * destroyed. ivi_id_in_use: ivi_id is already assigned by another
- * application.
+ * server-side warnings.
  */
 enum ivi_surface_warning_code {
-        IVI_SURFACE_WARNING_CODE_INVALID_WL_SURFACE = 1,
-        IVI_SURFACE_WARNING_CODE_IVI_ID_IN_USE = 2,
+        IVI_SURFACE_WARNING_CODE_INVALID_WL_SURFACE = 1, /**< Surface is invalid. */
+        IVI_SURFACE_WARNING_CODE_IVI_ID_IN_USE = 2, /**< ivi_id is in use and cannot be shared. */
 };
 #endif /* IVI_SURFACE_WARNING_CODE_ENUM */
 
 /**
- * ivi_surface - application interface to surface in ivi compositor
- * @visibility: visibility of surface in ivi compositor has changed
- * @warning: server-side warning detected
- *
- *
+ * @brief Application interface to surface in ivi compositor
  */
 struct ivi_surface_listener {
         /**
-         * visibility - visibility of surface in ivi compositor has
+         * @brief Visibility of surface in ivi compositor has
          *      changed
-         * @visibility: (none)
          *
-         * The new visibility state is provided in argument visibility.
-         * If visibility is 0, the surface has become invisible. If
-         * visibility is not 0, the surface has become visible.
+         * The new visibility state is provided in argument @p visibility.
+         * If @p visibility is 0, the surface has become invisible. If
+         * @p visibility is not 0, the surface has become visible.
          */
         void (*visibility)(void *data,
                            struct ivi_surface *ivi_surface,
                            int32_t visibility);
         /**
-         * warning - server-side warning detected
-         * @warning_code: (none)
-         * @warning_text: (none)
+         * @brief Server-side warning detected
          *
          * The ivi compositor encountered warning while processing a
          * request by this application. The warning is defined by argument
-         * warning_code and optional warning_text. If the warning is
-         * detected, client shall destroy the ivi_surface object.
+         * @p warning_code and optional @p warning_text. If the warning is
+         * detected, client shall destroy the @p ivi_surface object.
          *
          * When a warning event is sent, the compositor turns the
-         * ivi_surface object inert. The ivi_surface will not deliver
+         * @p ivi_surface object inert. The @p ivi_surface will not deliver
          * further events, all requests on it are ignored except 'destroy',
          * and the association to the ivi_id is removed. The client should
-         * destroy the ivi_surface object. If an inert ivi_surface object
+         * destroy the @p ivi_surface object. If an inert @p ivi_surface object
          * is used as an argument to any other object's request, that
          * request will [produce a fatal error / produce a warning / be
          * ignored].

diff --git a/src/lib/ecore_wayland/xdg-shell-client-protocol.h b/src/lib/ecore_wayland/xdg-shell-client-protocol.h
index 24b92b0..2b20845 100644 (file)
--- a/src/lib/ecore_wayland/xdg-shell-client-protocol.h
+++ b/src/lib/ecore_wayland/xdg-shell-client-protocol.h
@@ -77,8 +77,7 @@ enum xdg_shell_error {
 #endif /* XDG_SHELL_ERROR_ENUM */
 
 /**
- * xdg_shell - create desktop-style surfaces
- * @ping: check if the client is alive
+ * @brief Create desktop-style surfaces
  *
  * xdg_shell allows clients to turn a wl_surface into a "real window"
  * which can be dragged, resized, stacked, and moved around by the user.
@@ -87,8 +86,7 @@ enum xdg_shell_error {
  */
 struct xdg_shell_listener {
        /**
-        * ping - check if the client is alive
-        * @serial: pass this to the pong request
+        * @brief Check if the client is alive
         *
         * The ping event asks the client if it's still alive. Pass the
         * serial specified in the event back to the compositor by sending
@@ -101,6 +99,8 @@ struct xdg_shell_listener {
         *
         * A compositor is free to ping in any way it wants, but a client
         * must always respond to any xdg_shell object it created.
+   *
+        * @param serial Pass this to the pong request
         */
        void (*ping)(void *data,
                     struct xdg_shell *xdg_shell,
@@ -181,16 +181,7 @@ xdg_shell_pong(struct xdg_shell *xdg_shell, uint32_t serial)
 #ifndef XDG_SURFACE_RESIZE_EDGE_ENUM
 #define XDG_SURFACE_RESIZE_EDGE_ENUM
 /**
- * xdg_surface_resize_edge - edge values for resizing
- * @XDG_SURFACE_RESIZE_EDGE_NONE: (none)
- * @XDG_SURFACE_RESIZE_EDGE_TOP: (none)
- * @XDG_SURFACE_RESIZE_EDGE_BOTTOM: (none)
- * @XDG_SURFACE_RESIZE_EDGE_LEFT: (none)
- * @XDG_SURFACE_RESIZE_EDGE_TOP_LEFT: (none)
- * @XDG_SURFACE_RESIZE_EDGE_BOTTOM_LEFT: (none)
- * @XDG_SURFACE_RESIZE_EDGE_RIGHT: (none)
- * @XDG_SURFACE_RESIZE_EDGE_TOP_RIGHT: (none)
- * @XDG_SURFACE_RESIZE_EDGE_BOTTOM_RIGHT: (none)
+ * @brief Edge values for resizing
  *
  * These values are used to indicate which edge of a surface is being
  * dragged in a resize operation. The server may use this information to
@@ -212,11 +203,7 @@ enum xdg_surface_resize_edge {
 #ifndef XDG_SURFACE_STATE_ENUM
 #define XDG_SURFACE_STATE_ENUM
 /**
- * xdg_surface_state - types of state on the surface
- * @XDG_SURFACE_STATE_MAXIMIZED: the surface is maximized
- * @XDG_SURFACE_STATE_FULLSCREEN: the surface is fullscreen
- * @XDG_SURFACE_STATE_RESIZING: (none)
- * @XDG_SURFACE_STATE_ACTIVATED: (none)
+ * @brief Types of state on the surface
  *
  * The different state values used on the surface. This is designed for
  * state values like maximized, fullscreen. It is paired with the configure
@@ -246,9 +233,7 @@ enum xdg_surface_state {
 #endif /* XDG_SURFACE_STATE_ENUM */
 
 /**
- * xdg_surface - A desktop window
- * @configure: suggest a surface change
- * @close: surface wants to be closed
+ * @brief A desktop window
  *
  * An interface that may be implemented by a wl_surface, for
  * implementations that provide a desktop-style user interface.
@@ -272,11 +257,7 @@ enum xdg_surface_state {
  */
 struct xdg_surface_listener {
        /**
-        * configure - suggest a surface change
-        * @width: (none)
-        * @height: (none)
-        * @states: (none)
-        * @serial: (none)
+        * @brief Suggest a surface change
         *
         * The configure event asks the client to resize its surface or
         * to change its state.
@@ -311,7 +292,7 @@ struct xdg_surface_listener {
                          struct wl_array *states,
                          uint32_t serial);
        /**
-        * close - surface wants to be closed
+        * @brief Surface wants to be closed
         *
         * The close event is sent by the compositor when the user wants
         * the surface to be closed. This should be equivalent to the user
@@ -462,8 +443,7 @@ xdg_surface_set_minimized(struct xdg_surface *xdg_surface)
 }
 
 /**
- * xdg_popup - short-lived, popup surfaces for menus
- * @popup_done: popup interaction is done
+ * @brief Short-lived popup surfaces for menus
  *
  * A popup surface is a short-lived, temporary surface that can be used
  * to implement menus. It takes an explicit grab on the surface that will
@@ -513,7 +493,7 @@ xdg_surface_set_minimized(struct xdg_surface *xdg_surface)
  */
 struct xdg_popup_listener {
        /**
-        * popup_done - popup interaction is done
+        * @brief Popup interaction is done
         *
         * The popup_done event is sent out when a popup is dismissed by
         * the compositor. The client should destroy the xdg_popup object