[libvtemm] Added documentation for Devhelp users.
- From: Krzesimir Nowak <krnowak src gnome org>
- To: svn-commits-list gnome org
- Subject: [libvtemm] Added documentation for Devhelp users.
- Date: Tue, 16 Jun 2009 14:08:22 -0400 (EDT)
commit e1505e97e8bb885ff654866c722752ff1bc22d85
Author: Krzesimir Nowak <krnowak svn gnome org>
Date: Tue Jun 16 20:03:28 2009 +0200
Added documentation for Devhelp users.
* configure.ac: Added check for xsltproc needed for building
devhelp file.
* docs/reference/Makefile.am: Added building devhelp file.
configure.ac | 2 +
docs/reference/Makefile.am | 66 ++++++++++++++++++++++++++++++--------------
2 files changed, 47 insertions(+), 21 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index ff28e4d..44858ef 100644
--- a/configure.ac
+++ b/configure.ac
@@ -106,6 +106,8 @@ AL_PROG_PERL(AC_MSG_ERROR([Perl is required to build libvtemm.]))
AC_CHECK_PROGS(PERL, perl5 perl)
+AC_CHECK_PROGS(XSLTPROC, xsltproc)
+
#########################################################################
# Dependency checks
#########################################################################
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index f3991b1..0b8457d 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,25 +1,43 @@
+include $(top_srcdir)/src/Makefile_sublib.am_fragment
+
doxygen_configfile = Doxyfile
doxygen_configfile_source = $(srcdir)/Doxyfile.in
beautify_docs = @GMM_PROCDIR@/beautify_docs.pl
-# glibmm_doxygen_tags and gtkmm_doxygen_tags are copies from glibmm and gtkmm, used here.
+devhelp_file = $(sublib_libname).devhelp
+devhelp_stylesheet = @GMM_PROCDIR@/doxygen_to_devhelp.xsl
+devhelpdir = $(datadir)/devhelp/books/$(sublib_libname)
+refdir = $(datadir)/doc/$(sublib_libname)/docs/reference/html/
+
+xml_index = xml/index.xml
+html_index = html/index.html
+
+# glibmm_doxygen_tags, gtkmm_doxygen_tags and pango_doxygen_tags are copies from
+# glibmm, gtkmm and pangomm, used here.
# libvtemm_doxygen_tags is generated, in case another project wants to use it.
-#
+
EXTRA_DIST = README Doxyfile.in $(doxygen_configfile) \
- libvtemm_header.html_fragment libvtemm_footer.html_fragment html
-include $(top_srcdir)/src/Makefile_sublib.am_fragment
-# refdir = $(docdir)/docs/reference/html/
-refdir = $(datadir)/doc/$(sublib_libname)/docs/reference/html/
+ $(sublib_name)_header.html_fragment \
+ $(sublib_name)_footer.html_fragment \
+ html $(sublib_name)_doxygen_tags $(devhelp_file) $(xml_index)
+
+$(devhelp_file): $(xml_index) $(devhelp_stylesheet)
+ @XSLTPROC@ --stringparam book_title "$(sublib_name) $(sublib_api_version) Reference Manual" \
+ --stringparam book_name "$(sublib_name) $(sublib_api_version)" \
+ --stringparam reference_prefix "../../../doc/$(sublib_libname)/docs/reference/html" \
+ -o $@ $(devhelp_stylesheet) $(xml_index)
# The html is generated by doxygen. We generate xml also, but we are not distributing it yet.
# The installdox thing is part of doxygen - it fixes the URLs to point to the glibmm reference docs.
# beautify_docs moves the * and & next to the C++ types rather than the parameter names.
-html/index.html: $(doxygen_configfile_source)
+$(html_index) $(xml_index): $(doxygen_configfile_source)
-rm -rf html
+ -rm -rf xml
doxygen $(doxygen_configfile) \
2> doxygen-warnings.txt | tee doxygen-output.txt && cat doxygen-warnings.txt
- cd html && ./installdox -l glibmm_doxygen_tags http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html \
- -l gtkmm_doxygen_tags http://www.gtkmm.org/docs/gtkmm-2.4/docs/reference/html \
+ cd html && ./installdox -l glibmm_doxygen_tags /../../../glibmm-2.4/docs/reference/html \
+ -l gtkmm_doxygen_tags /../../../gtkmm-2.4/docs/reference/html \
+ -l pangomm_doxygen_tags /../../../pangomm-1.4/docs/reference/html/ \
2>> doxygen-warnings.txt | tee -a doxygen-output.txt && cd ..
$(beautify_docs) html 2>> doxygen-warnings.txt | tee -a doxygen-output.txt
@@ -31,32 +49,38 @@ install-reference: html/index.html
echo " $(INSTALL_DATA) $$p $(DESTDIR)$(refdir)/$$f"; \
$(INSTALL_DATA) $$p $(DESTDIR)$(refdir)/$$f; \
done
-# $(INSTALL_DATA) $(srcdir)/widget_hierarchy.png $(DESTDIR)$(referencetopdir)/$$f;
-# $(INSTALL_DATA) $(srcdir)/widget_hierarchy.html $(DESTDIR)$(referencetopdir)/$$f;
-uninstall-reference: html/index.html
+uninstall-reference: $(html_index)
@$(NORMAL_UNINSTALL)
@dir='$(<D)'; for p in $$dir/*.html $$dir/*.css $$dir/*.png $$dir/*.dot ; do \
f="`echo $$p | sed -e 's|^.*/||'`"; \
echo " rm -f $(DESTDIR)$(refdir)/$$f"; \
rm -f $(DESTDIR)$(refdir)/$$f; \
done
-# rm -f $(DESTDIR)$(referencetopdir)/widget_hierarchy.png
-# rm -f $(DESTDIR)$(referencetopdir)/widget_hierarchy.html
-all-local: html/index.html
+install-devhelp: $(devhelp_file)
+ $(mkinstalldirs) $(DESTDIR)$(devhelpdir)
+ $(INSTALL_DATA) $(srcdir)/$(devhelp_file) $(DESTDIR)$(devhelpdir)/$(devhelp_file)
+
+uninstall-devhelp:
+ rm -f $(DESTDIR)$(devhelpdir)/$(devhelp_file)
+
+doc-clean:
+ -rm -rf html
+ -rm -rf xml
+ -rm -f $(devhelp_file)
+ -rm -f $(sublib_name)_doxygen_tags
-install-data-local: install-reference
+all-local: $(html_index) $(devhelp_file)
-uninstall-local: uninstall-reference
+install-data-local: install-reference install-devhelp
-.PHONY: doc-clean install-reference uninstall-reference html-clean
+uninstall-local: uninstall-reference uninstall-devhelp
+maintainer-clean-local: doc-clean
-# Direct all the doxygen console output to a text file, so we can read it later:
-# In doxywizard, disable EXTRACT_ALL to get warnings about undocumented methods.
-doxygen-warnings: html-clean html/index.html
+.PHONY: doc-clean install-reference uninstall-reference doc-clean install-devhelp uninstall-devhelp
-include $(top_srcdir)/git.mk
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]