[PATCH 0/6] More utils/wayland-server documentation

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


Howdy,

I went ahead and added some more documentation for some utils classes, the
big one being wl_list.

I know I have some patches still outstanding, so I apologize if it's rude
to submit another batch before the previous ones have been resolved. These
patches apply regardless of whether the others are eventually accepted, so
in that sense, they're independent.

I've been prefixing my commits with the conventional prefix for that file
(e.g. utils: for wayland-utils.*, wayland-server and so forth). Should
I prefix these with doc: instead?

Thanks for your feedback!

Aaron Faanes (6):
  utils: Reference some useful methods in wl_signal's doxygen
  utils: Add doxygen for wayland-util.h
  wayland-server: Improve wording for wl_signal_get's doc
  doc: Include wayland-util.* for doxygen output
  utils: Ensure wl_list's doxygen formats properly
  utils: Document wl_list methods

 doc/doxygen/Makefile.am |   6 +++
 src/wayland-server.h    |   9 +++-
 src/wayland-util.h      | 113 ++++++++++++++++++++++++++++++++++++++++--------
 3 files changed, 107 insertions(+), 21 deletions(-)

-- 
1.8.3.1



More information about the wayland-devel mailing list