Carlos Eduardo Rodrigues Diogenes wrote:
Hi, I altered the gnome-mag makefiles to produce API documentation with doxygen, but I don't produced a patch yet because I think that gtk-doc can be a better solution for this. What do you think Bill? It's used in libglade and gtk+. I'm downloading the gtk+ module from cvs to see how this is used.
I look at it in gtk+ and It appear to be much more work to produce API documentation with gtk-doc and I think that what we can do with doxygen is easier and quickly and attend the necessities that the project have now... I'm sending the patch for Makefile.am and configure.in in the main gnome-mag directory and I'm sending too the new docs dir in tar.gz. I copied the base for the makefiles from the gtkmm project and they have some targets in makefile to post the documentation in their website, I think that this could be interesting. If the answer is yes, I can make the modifications in the makefiles. Carlos.
Index: Makefile.am =================================================================== RCS file: /cvs/gnome/gnome-mag/Makefile.am,v retrieving revision 1.5 diff -u -p -r1.5 Makefile.am --- Makefile.am 8 Apr 2004 19:30:41 -0000 1.5 +++ Makefile.am 4 Oct 2005 19:15:57 -0000 @@ -1,6 +1,6 @@ # Process this file with automake to create Makefile.in. -SUBDIRS = idl magnifier test po cursors +SUBDIRS = idl magnifier test po cursors docs pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA= gnome-mag-1.0.pc @@ -10,8 +10,21 @@ EXTRA_DIST=gnome-mag-1.0.pc.in \ intltool-merge.in \ intltool-update.in +doc_tarball_files = \ + docs/reference/html -.PHONY: files +gnome-mag-1-0-docs.tar.gz: + tar cv - --files-from - $(doc_tarball_files) | gzip -c --best >$@ + +doc-clean-recursive: + (cd docs && $(MAKE) $(AM_MAKEFLAGS) doc-clean) + +doc-clean: doc-clean-recursive + +doc-rebuild: + (cd docs && $(MAKE) $(AM_MAKEFLAGS) doc-rebuild) + +.PHONY: files doc-clean doc-clean-recursive doc-rebuild files: @for subdir in $(SUBDIRS); do\
Index: configure.in =================================================================== RCS file: /cvs/gnome/gnome-mag/configure.in,v retrieving revision 1.92 diff -u -p -r1.92 configure.in --- configure.in 7 Jun 2005 20:35:26 -0000 1.92 +++ configure.in 4 Oct 2005 19:15:08 -0000 @@ -262,4 +262,6 @@ magnifier/Makefile cursors/Makefile cursors/1_32/Makefile test/Makefile +docs/Makefile +docs/reference/Makefile ])
Attachment:
docs.tar.gz
Description: GNU Zip compressed data