mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-10-31 22:25:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
wayland/doc/doxygen/Makefile.am

54 lines
1.7 KiB
Text
Raw Normal View History

doc: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
doc: generate server documentation from XML too Same as WaylandClientAPI.xml we now also generate WaylandServerAPI.xml for publication. Most of this hunk is just adding a client/ or server/ into the xml path to keep the two separate. The change in wayland.doxygen now causes a standard doxygen call to not generate anything - what is generated is specified through the options passed by make. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-04 11:28:58 +10:00
noinst_DATA = xml/client/index.xml xml/server/index.xml
doc: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
dist_noinst_DATA = wayland.doxygen.in
doc: Include wayland-util.* for doxygen output This commit creates a shared file list that is included by both the client and the server for the XML Makefile targets, as classes within util are used by both the client and the server.
2013-09-15 13:37:09 -05:00
scanned_src_files_shared = \
$(top_srcdir)/src/wayland-util.c \
$(top_srcdir)/src/wayland-util.h
doc: generate man pages from doxygen 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>
2013-04-02 11:08:59 +10:00
scanned_src_files_client = \
doc: Include wayland-util.* for doxygen output This commit creates a shared file list that is included by both the client and the server for the XML Makefile targets, as classes within util are used by both the client and the server.
2013-09-15 13:37:09 -05:00
$(scanned_src_files_shared) \
doc: Update doxygen documentation when source files are changed
2012-10-19 15:30:26 +03:00
$(top_srcdir)/src/wayland-client.c \
$(top_srcdir)/src/wayland-client.h
doc: generate man pages from doxygen 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>
2013-04-02 11:08:59 +10:00
scanned_src_files_server = \
doc: Include wayland-util.* for doxygen output This commit creates a shared file list that is included by both the client and the server for the XML Makefile targets, as classes within util are used by both the client and the server.
2013-09-15 13:37:09 -05:00
$(scanned_src_files_shared) \
doc: generate man pages from doxygen 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>
2013-04-02 11:08:59 +10:00
$(top_srcdir)/src/wayland-server.c \
Add documentation for wl_shm_buffer_begin/end_access It's not obvious that these functions are needed so it would be good to have some documentation for them.
2013-11-14 12:28:51 +00:00
$(top_srcdir)/src/wayland-server.h \
$(top_srcdir)/src/wayland-shm.c
doc: generate man pages from doxygen 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>
2013-04-02 11:08:59 +10:00
doc: use a dynamic list of man pages This requires that doxygen is run before the man target so find can actually find the man pages. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-04 11:29:01 +10:00
# find all man/man3/wl_foo.3 pages
# for this to work, we need to create them before the man target (hence
# all-local below)
doc: Quell warnings about missing man3 directory before its been built The shell command for dist_man3_MANS gets invoked several times during the make process but before the man pages have been generated, which causes the following warnings when running `make`: find: `man/man3': No such file or directory find: `man/man3': No such file or directory find: `man/man3': No such file or directory GEN xml/client/index.xml Despite these error messages, the generated dist tarball contains the man3 pages as intended, both before and after this patch. $ make dist $ tar xxf wayland-1.5.90.tar.xz $ find wayland-1.5.90/doc/doxygen/man/man3 -name "wl_*.3" | wc -l 85 Signed-off-by: Bryce Harrington <b.harrington@samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-07-21 19:23:49 +00:00
dist_man3_MANS = $(shell test -d man && find man/man3 -name "wl_*.3" -printf "man/man3/%P\n")
doc: generate man pages from doxygen 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>
2013-04-02 11:08:59 +10:00
doc: generate server documentation from XML too Same as WaylandClientAPI.xml we now also generate WaylandServerAPI.xml for publication. Most of this hunk is just adding a client/ or server/ into the xml path to keep the two separate. The change in wayland.doxygen now causes a standard doxygen call to not generate anything - what is generated is specified through the options passed by make. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-04 11:28:58 +10:00
xml/client/index.xml: $(scanned_src_files_client) wayland.doxygen
build: hide doxygen commands with AM_V_GEN I suppose the purpose was to print just one GEN line for each doxygen rule being executed, not print the doxygen command. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-03-10 14:03:59 +02:00
$(AM_V_GEN)$(MKDIR_P) xml/client && \
doc: generate server documentation from XML too Same as WaylandClientAPI.xml we now also generate WaylandServerAPI.xml for publication. Most of this hunk is just adding a client/ or server/ into the xml path to keep the two separate. The change in wayland.doxygen now causes a standard doxygen call to not generate anything - what is generated is specified through the options passed by make. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-04 11:28:58 +10:00
(cat wayland.doxygen; \
echo "GENERATE_XML=YES"; \
echo "XML_OUTPUT=xml/client"; \
echo "INPUT= $(scanned_src_files_client)"; \
) | doxygen -
xml/server/index.xml: $(scanned_src_files_server) wayland.doxygen
build: hide doxygen commands with AM_V_GEN I suppose the purpose was to print just one GEN line for each doxygen rule being executed, not print the doxygen command. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-03-10 14:03:59 +02:00
$(AM_V_GEN)$(MKDIR_P) xml/server && \
doc: generate server documentation from XML too Same as WaylandClientAPI.xml we now also generate WaylandServerAPI.xml for publication. Most of this hunk is just adding a client/ or server/ into the xml path to keep the two separate. The change in wayland.doxygen now causes a standard doxygen call to not generate anything - what is generated is specified through the options passed by make. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-04 11:28:58 +10:00
(cat wayland.doxygen; \
echo "GENERATE_XML=YES"; \
echo "XML_OUTPUT=xml/server"; \
echo "INPUT= $(scanned_src_files_server)"; \
) | doxygen -
doc: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
doc: do not rebuild man pages if they are up to date The doxygen.man make target was not a real file that was generated, therefore the man page rule was ran on every make invocation. Replace it with a real file that is produced by the man page rule. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-03-10 14:03:58 +02:00
man/man3/wl_display.3: $(scanned_src_files_client) $(scanned_src_files_server)
build: hide doxygen commands with AM_V_GEN I suppose the purpose was to print just one GEN line for each doxygen rule being executed, not print the doxygen command. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-03-10 14:03:59 +02:00
$(AM_V_GEN)(cat wayland.doxygen; \
doc: generate man pages from doxygen 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>
2013-04-02 11:08:59 +10:00
echo "GENERATE_MAN=YES"; \
echo "MAN_OUTPUT=man"; \
echo "JAVADOC_AUTOBRIEF=NO"; \
echo "INPUT= $^"; \
) | doxygen -
doc: use a dynamic list of man pages This requires that doxygen is run before the man target so find can actually find the man pages. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-04 11:29:01 +10:00
# there is no man-local
doc: do not rebuild man pages if they are up to date The doxygen.man make target was not a real file that was generated, therefore the man page rule was ran on every make invocation. Replace it with a real file that is produced by the man page rule. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-03-10 14:03:58 +02:00
all-local: man/man3/wl_display.3
doc: generate man pages from doxygen 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>
2013-04-02 11:08:59 +10:00
doc: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
clean-local:
rm -rf xml/
doc: generate man pages from doxygen 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>
2013-04-02 11:08:59 +10:00
rm -rf man/
Reference in a new issue Copy permalink