[PATCH 9/9] doc: Removed \ref when it refers to the subject the text is attached to
Bill Spitzak
spitzak at gmail.com
Tue Nov 11 18:43:02 PST 2014
This does not make a difference to doxygen output but may help other
document generators not make redundant links.
---
src/wayland-client.c | 2 +-
src/wayland-client.h | 10 +++++-----
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/src/wayland-client.c b/src/wayland-client.c
index 16df207..9172f7c 100644
--- a/src/wayland-client.c
+++ b/src/wayland-client.c
@@ -1537,7 +1537,7 @@ wl_display_dispatch(struct wl_display *display)
* to dispatch.
*
* To proper integrate the wayland display fd into a main loop, the
- * client should always call \ref wl_display_dispatch_pending() and then
+ * client should always call wl_display_dispatch_pending() and then
* \ref wl_display_flush() prior to going back to sleep. At that point,
* the fd typically doesn't have data so attempting I/O could block, but
* events queued up on the main queue should be dispatched.
diff --git a/src/wayland-client.h b/src/wayland-client.h
index 0801a81..dd42d7b 100644
--- a/src/wayland-client.h
+++ b/src/wayland-client.h
@@ -41,7 +41,7 @@ extern "C" {
* turn call the handler set with \ref wl_proxy_add_listener().
*
* \note With the exception of function \ref wl_proxy_set_queue(), functions
- * accessing a \ref wl_proxy are not normally used by client code. Clients
+ * accessing a wl_proxy are not normally used by client code. Clients
* should normally use the higher level interface generated by the scanner to
* interact with compositor objects.
*
@@ -53,15 +53,15 @@ struct wl_proxy;
* \brief Represents a connection to the compositor and acts as a proxy to
* the wl_display singleton object.
*
- * A \ref wl_display object represents a client connection to a Wayland
+ * A wl_display object represents a client connection to a Wayland
* compositor. It is created with either \ref wl_display_connect() or
* \ref wl_display_connect_to_fd(). A connection is terminated using
* \ref wl_display_disconnect().
*
- * A \ref wl_display is also used as the \ref wl_proxy for the \ref wl_display
+ * A wl_display is also used as the \ref wl_proxy for the wl_display
* singleton object on the compositor side.
*
- * A \ref wl_display object handles all the data sent from and to the
+ * A wl_display object handles all the data sent from and to the
* compositor. When a \ref wl_proxy marshals a request, it will write its wire
* representation to the display's write buffer. The data is sent to the
* compositor when the client calls \ref wl_display_flush().
@@ -71,7 +71,7 @@ struct wl_proxy;
* added to a queue. On the dispatch step, the handler for the incoming
* event set by the client on the corresponding \ref wl_proxy is called.
*
- * A \ref wl_display has at least one event queue, called the <em>main
+ * A wl_display has at least one event queue, called the <em>main
* queue</em>. Clients can create additional event queues with \ref
* wl_display_create_queue() and assign \ref wl_proxy's to it. Events
* occurring in a particular proxy are always queued in its assigned queue.
--
1.7.9.5
More information about the wayland-devel
mailing list