[PATCH wayland 1/5] doc: Insert \brief doxygen command
Ran Benita
ran234 at gmail.com
Mon Nov 12 07:33:07 PST 2012
On Mon, Nov 12, 2012 at 10:32:14AM -0200, Tiago Vignatti wrote:
> Signed-off-by: Tiago Vignatti <tiago.vignatti at intel.com>
Might be easier to just set JAVADOC_AUTOBRIED = YES in the doxygen file?
Typing '\brief' all the time can get a bit annoying.
Ran
> ---
> src/wayland-client.c | 85 +++++++++++++++++++++++++-------------------------
> 1 file changed, 42 insertions(+), 43 deletions(-)
>
> diff --git a/src/wayland-client.c b/src/wayland-client.c
> index d3a7970..970c292 100644
> --- a/src/wayland-client.c
> +++ b/src/wayland-client.c
> @@ -138,8 +138,8 @@ wl_event_queue_release(struct wl_event_queue *queue)
> pthread_cond_destroy(&queue->cond);
> }
>
> -/** Destroy an event queue
> - *
> +/**
> + * \brief Destroy an event queue
> * \param queue The event queue to be destroyed
> *
> * Destroy the given event queue. Any pending event on that queue is
> @@ -163,8 +163,8 @@ wl_event_queue_destroy(struct wl_event_queue *queue)
> pthread_mutex_unlock(&display->mutex);
> }
>
> -/** Create a new event queue for this display
> - *
> +/**
> + * \brief Create a new event queue for this display
> * \param display The display context object
> * \return A new event queue associated with this display or NULL on
> * failure.
> @@ -189,8 +189,8 @@ wl_display_create_queue(struct wl_display *display)
> return queue;
> }
>
> -/** Create a proxy object with a given interface
> - *
> +/**
> + * \brief Create a proxy object with a given interface
> * \param factory Factory proxy object
> * \param interface Interface the proxy object should use
> * \return A newly allocated proxy object or NULL on failure
> @@ -258,8 +258,8 @@ wl_proxy_create_for_id(struct wl_proxy *factory,
> return proxy;
> }
>
> -/** Destroy a proxy object
> - *
> +/**
> + * \brief Destroy a proxy object
> * \param proxy The proxy to be destroyed
> *
> * \memberof wl_proxy
> @@ -290,8 +290,8 @@ wl_proxy_destroy(struct wl_proxy *proxy)
> pthread_mutex_unlock(&display->mutex);
> }
>
> -/** Set a proxy's listener
> - *
> +/**
> + * \brief Set a proxy's listener
> * \param proxy The proxy object
> * \param implementation The listener to be added to proxy
> * \param data User data to be associated with the proxy
> @@ -322,8 +322,8 @@ wl_proxy_add_listener(struct wl_proxy *proxy,
> return 0;
> }
>
> -/** Prepare a request to be sent to the compositor
> - *
> +/**
> + * \brief Prepare a request to be sent to the compositor
> * \param proxy The proxy object
> * \param opcode Opcode of the request to be sent
> * \param ... Extra arguments for the given request
> @@ -484,8 +484,8 @@ connect_to_socket(const char *name)
> return fd;
> }
>
> -/** Connect to Wayland display on an already open fd
> - *
> +/**
> + * \brief Connect to Wayland display on an already open fd
> * \param fd The fd to use for the connection
> * \return A \ref wl_display object or \c NULL on failure
> *
> @@ -543,8 +543,8 @@ wl_display_connect_to_fd(int fd)
> return display;
> }
>
> -/** Connect to a Wayland display
> - *
> +/**
> + * \brief Connect to a Wayland display
> * \param name Name of the Wayland display to connect to
> * \return A \ref wl_display object or \c NULL on failure
> *
> @@ -579,8 +579,8 @@ wl_display_connect(const char *name)
> return wl_display_connect_to_fd(fd);
> }
>
> -/** Close a connection to a Wayland display
> - *
> +/**
> + * \brief Close a connection to a Wayland display
> * \param display The display context object
> *
> * Close the connection to \c display and free all resources associated
> @@ -601,8 +601,8 @@ wl_display_disconnect(struct wl_display *display)
> free(display);
> }
>
> -/** Get a display context's file descriptor
> - *
> +/**
> + * \brief Get a display context's file descriptor
> * \param display The display context object
> * \return Display object file descriptor
> *
> @@ -630,8 +630,8 @@ static const struct wl_callback_listener sync_listener = {
> sync_callback
> };
>
> -/** Block until all pending request are processed by the server
> - *
> +/**
> + * \brief Block until all pending request are processed by the server
> * \param display The display context object
> * \return The number of dispatched events on success or -1 on failure
> *
> @@ -903,8 +903,8 @@ err_unlock:
> return -1;
> }
>
> -/** Dispatch events in an event queue
> - *
> +/**
> + * \brief Dispatch events in an event queue
> * \param display The display context object
> * \param queue The event queue to dispatch
> * \return The number of dispatched events on success or -1 on failure
> @@ -926,8 +926,8 @@ wl_display_dispatch_queue(struct wl_display *display,
> return dispatch_queue(display, queue, 1);
> }
>
> -/** Process incoming events
> - *
> +/**
> + * \brief Process incoming events
> * \param display The display context object
> * \return The number of dispatched events on success or -1 on failure
> *
> @@ -956,8 +956,8 @@ wl_display_dispatch(struct wl_display *display)
> return dispatch_queue(display, &display->queue, 1);
> }
>
> -/** Dispatch main queue events without reading from the display fd
> - *
> +/**
> + * \brief Dispatch main queue events without reading from the display fd
> * \param display The display context object
> * \return The number of dispatched events or -1 on failure
> *
> @@ -1002,12 +1002,12 @@ wl_display_dispatch_pending(struct wl_display *display)
> return dispatch_queue(display, &display->queue, 0);
> }
>
> -/** Retrieve the last error occured on a display
> - *
> +/**
> + * \brief Retrieve the last error occurred on a display
> * \param display The display context object
> - * \return The last error occured on \c display or 0 if no error occured
> + * \return The last error occurred on \c display or 0 if no error occurred
> *
> - * Return the last error occured on the display. This may be an error sent
> + * Return the last error occurred on the display. This may be an error sent
> * by the server or caused by the local client.
> *
> * \note Errors are \b fatal. If this function returns non-zero the display
> @@ -1029,8 +1029,8 @@ wl_display_get_error(struct wl_display *display)
> return ret;
> }
>
> -/** Send all buffered request on the display to the server
> - *
> +/**
> + * \brief Send all buffered request on the display to the server
> * \param display The display context object
> * \return The number of bytes send on success or -1 on failure
> *
> @@ -1062,8 +1062,8 @@ wl_display_flush(struct wl_display *display)
> return ret;
> }
>
> -/** Set the user data associated with a proxy
> - *
> +/**
> + * \brief Set the user data associated with a proxy
> * \param proxy The proxy object
> * \param user_data The data to be associated with proxy
> *
> @@ -1078,8 +1078,8 @@ wl_proxy_set_user_data(struct wl_proxy *proxy, void *user_data)
> proxy->user_data = user_data;
> }
>
> -/** Get the user data associated with a proxy
> - *
> +/**
> + * \brief Get the user data associated with a proxy
> * \param proxy The proxy object
> * \return The user data associated with proxy
> *
> @@ -1091,8 +1091,8 @@ wl_proxy_get_user_data(struct wl_proxy *proxy)
> return proxy->user_data;
> }
>
> -/** Get the id of a proxy object
> - *
> +/**
> + * \brief Get the id of a proxy object
> * \param proxy The proxy object
> * \return The id the object associated with the proxy
> *
> @@ -1104,9 +1104,8 @@ wl_proxy_get_id(struct wl_proxy *proxy)
> return proxy->object.id;
> }
>
> -
> -/** Assign a proxy to an event queue
> - *
> +/**
> + * \brief Assign a proxy to an event queue
> * \param proxy The proxy object
> * \param queue The event queue that will handle this proxy
> *
> --
> 1.7.9.5
>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel
More information about the wayland-devel
mailing list