mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-03-26 07:58:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: generate man pages from doxygen

Browse source 
Create client-side and server-side man pages from doxygen. The doxygen
config options are virtually the same as for the XML output, but we do pass
in the specific options via stdin.

WL_EXPORT is predefined to the empty string, it makes the man page look
confusing and provides no value here anyway. This applies for both xml and
man output.

JAVADOC_AUTOBRIEF is disabled for man pages, the formatting in the resulting
man page is IMO hard to read.

Most of the server man pages are virtually empty, there's just not enough
documentation in the source files.

Interesting issue: the usage of @code in the protocol to reference the
parameter breaks the expansion of WL_EXPORT, thus leaving us with WL_EXPORT
in all the man pages.
Presumably this is an issue with doxygen interpreting this as a @code
command, but I already wasted enough time narrowing this down.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2013-04-02 11:08:59 +10:00 • committed by Kristian Høgsberg
parent e5202f76b0
commit 8ccab1ba62
2 changed files with 72 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

71
doc/doxygen/Makefile.am
View file

@ -2,12 +2,79 @@
noinst_DATA = xml/index.xml
dist_noinst_DATA = wayland.doxygen.in
scanned_src_files = \
scanned_src_files_client = \
$(top_srcdir)/src/wayland-client.c \
$(top_srcdir)/src/wayland-client.h
xml/index.xml: $(scanned_src_files) wayland.doxygen
scanned_src_files_server = \
$(top_srcdir)/src/wayland-server.c \
$(top_srcdir)/src/wayland-server.h
client_MANPAGES = \
man/man3/wl_display.3 \
man/man3/wl_display_connect.3 \
man/man3/wl_display_connect_to_fd.3 \
man/man3/wl_display_create_queue.3 \
man/man3/wl_display_disconnect.3 \
man/man3/wl_display_dispatch.3 \
man/man3/wl_display_dispatch_pending.3 \
man/man3/wl_display_dispatch_queue.3 \
man/man3/wl_display_dispatch_queue_pending.3 \
man/man3/wl_display_flush.3 \
man/man3/wl_display_get_error.3 \
man/man3/wl_display_get_fd.3 \
man/man3/wl_display_roundtrip.3 \
man/man3/wl_event_queue.3 \
man/man3/wl_event_queue_destroy.3 \
man/man3/wl_proxy.3 \
man/man3/wl_proxy_add_listener.3 \
man/man3/wl_proxy_create.3 \
man/man3/wl_proxy_destroy.3 \
man/man3/wl_proxy_get_class.3 \
man/man3/wl_proxy_get_id.3 \
man/man3/wl_proxy_get_user_data.3 \
man/man3/wl_proxy_marshal.3 \
man/man3/wl_proxy_set_queue.3 \
man/man3/wl_proxy_set_user_data.3
server_MANPAGES = \
man/man3/wl_buffer.3 \
man/man3/wl_client.3 \
man/man3/wl_data_offer.3 \
man/man3/wl_data_source.3 \
man/man3/wl_global.3 \
man/man3/wl_keyboard.3 \
man/man3/wl_keyboard_grab.3 \
man/man3/wl_keyboard_grab_interface.3 \
man/man3/wl_listener.3 \
man/man3/wl_pointer.3 \
man/man3/wl_pointer_grab.3 \
man/man3/wl_pointer_grab_interface.3 \
man/man3/wl_resource.3 \
man/man3/wl_seat.3 \
man/man3/wl_signal.3 \
man/man3/wl_socket.3 \
man/man3/wl_surface.3 \
man/man3/wl_touch.3 \
man/man3/wl_touch_grab.3 \
man/man3/wl_touch_grab_interface.3
man3_MANS= $(client_MANPAGES) $(server_MANPAGES)
xml/index.xml: $(scanned_src_files_client) wayland.doxygen
doxygen wayland.doxygen
doxygen.man: $(scanned_src_files_client) $(scanned_src_files_server)
(cat wayland.doxygen; \
echo "GENERATE_XML=NO"; \
echo "GENERATE_MAN=YES"; \
echo "MAN_OUTPUT=man"; \
echo "JAVADOC_AUTOBRIEF=NO"; \
echo "INPUT= $^"; \
) | doxygen -
$(client_MANPAGES) $(server_MANPAGES): doxygen.man
clean-local:
rm -rf xml/
rm -rf man/