[geany/geany] d8f75b: doxygen: generate xml too in preparation for gtkdoc generation - Commits

1 Mar 2016


      Branch:      refs/heads/master
Author:      Thomas Martitz kugel@rockbox.org
Committer:   Thomas Martitz kugel@rockbox.org
Date:        Sun, 07 Feb 2016 16:50:23 UTC
Commit:      d8f75b7d0f325ed930aed03f8d3122279b3a3a03
             https://github.com/geany/geany/commit/d8f75b7d0f325ed930aed03f8d3122279b3a3a...
Log Message:
-----------
doxygen: generate xml too in preparation for gtkdoc generation
A script will use the xml to generate a gtkdoc'ized header of the plugin API.
The xml files are also installed so that external users can use the xml
that corresponds to the installed version of Geany.
For now a separet doxyfile is used because the gtkdoc'ized header needs
a few types to be documented which not desired to be documented generally.
Modified Paths:
--------------
    .gitignore
    doc/Makefile.am
Modified: .gitignore
1 lines changed, 1 insertions(+), 0 deletions(-)
===================================================================
@@ -99,6 +99,7 @@ Makefile.in
 # /doc/
 #-----------------------------------------------------------------------
 /doc/Doxyfile
+/doc/Doxyfile-gi
 /doc/Doxyfile.stamp
 /doc/geany.1
 /doc/geany.html
Modified: doc/Makefile.am
16 lines changed, 13 insertions(+), 3 deletions(-)
===================================================================
@@ -99,14 +99,24 @@ doxygen_sources = \
    $(top_srcdir)/tagmanager/src/tm_source_file.[ch] \
    $(top_srcdir)/tagmanager/src/tm_workspace.[ch]
-Doxyfile.stamp: Doxyfile $(doxygen_sources)
-	$(AM_V_GEN)$(DOXYGEN) Doxyfile && echo "" > $@
+# set WARN_IF_UNDOCUMENTED because apparently doxygens warns for undocumented stuff
+# in headers (even though it's correctly documented in the corresponding .c file) only
+# for xml output
+Doxyfile-gi: Doxyfile
+	$(AM_V_GEN)$(SED) \
+		-e 's,^(GENERATE_HTML.*)YES,\1NO,' \
+		-e 's,^(GENERATE_XML.*)NO,\1YES,' \
+		-e 's,^(WARN_IF_UNDOCUMENTED.*)YES,\1NO,' \
+		$< > $@ || { $(RM) $@ && exit 1; }
+
+Doxyfile.stamp: Doxyfile Doxyfile-gi $(doxygen_sources)
+	$(AM_V_GEN)$(DOXYGEN) Doxyfile-gi && $(DOXYGEN) Doxyfile && echo "" > $@
all-local: Doxyfile.stamp
clean-local: clean-api-docs-local
 clean-api-docs-local:
-	-rm -rf reference/ Doxyfile.stamp doxygen_*
+	-rm -rf reference/ xml/ Doxyfile.stamp doxygen_*
endif
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).

    