[PATCH 2/6] utils: Add doxygen for wayland-util.h

Aaron Faanes dafrito at gmail.com
Sun Sep 15 11:37:07 PDT 2013


This is needed for doxygen to generate output for macro definitions, such
as wl_container_of, that are contained by this file. Classes like
wl_list would be documented regardless.
---
 src/wayland-util.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/wayland-util.h b/src/wayland-util.h
index f85c521..31a1ac2 100644
--- a/src/wayland-util.h
+++ b/src/wayland-util.h
@@ -20,6 +20,11 @@
  * OF THIS SOFTWARE.
  */
 
+/** \file wayland-util.h
+ *
+ * \brief Utility classes, functions, and macros.
+ */
+
 #ifndef WAYLAND_UTIL_H
 #define WAYLAND_UTIL_H
 
-- 
1.8.3.1



More information about the wayland-devel mailing list