[GenABEL-dev] Doxygen

[L.C. Karssen]

Hi Alvaro,

On 28-10-14 12:13, Frank, Alvaro Jesus wrote:
> Hi Lennart,
> 
> I am about to generate doxygen template documentation.

That's fantastic news!

> How should/is this handled from the side of svn and autotools.

Take a look at ProbABEL trunk. There's a test in configure.ac:

# Check for the presence of Doxygen
AC_CHECK_PROGS([DOXYGEN], doxygen)
if test -z "$DOXYGEN"; then
   AC_MSG_NOTICE([Doxygen not found - Not generating code documentation])
fi
AM_CONDITIONAL([HAVE_DOXYGEN],
               [test -n "$DOXYGEN"]) AM_COND_IF([HAVE_DOXYGEN],
               [AC_CONFIG_FILES([doc/Doxyfile])])

If doxygen is found, the Automake variable HAVE_DOXYGEN is set. It also
generates the file doc/Doxyfile based on the template in
doc/Doxyfile.in. Note the use of the Autoconf variables @PACKAGE_NAME@
and @PACKAGE_VERSION@ for the Doxygen variables PROJECT_NAME and
PROJECT_NUMBER, respectively. This way the correct name and version
number are automatically added to the Doxygen documentation when your
run ./configure (assuming you have set the correct version in the
configure.ac AC_INIT line)

In doc/Makefile.am I then use it to generate the doxygen documentation:

if HAVE_DOXYGEN
doxygen.stamp: Doxyfile
	$(DOXYGEN) $<
	echo Timestamp > $@

CLEANFILES += doxygen.stamp

all-local: doxygen.stamp

# CLEANFILES is only for files, so add an entry for the doxygen directory
clean-local:
	-rm -rf doxygen-docs
endif



I'm starting to wonder about one thing: In ProbABEL I'm using recursive
Automake files, i.e. each subdirectory has it's own Makefile.am. Nice
and clean. However, recursive make is considered harmful [1,2], so
that's why I change to non-recursive make for OmicABELnoMM. However, I
get the idea that this creates more problems than it solves. For
example, in ProbABEL I have no problems with my pdflatex code in
doc/Makefile.am, whereas I can't seem to get it to work with
OmicABELnoMM's Makefile.am.
Another thing is that the single Makefile.am of OAnMM is becoming quite
large. Of course we could split it up in the various subdirectories and
include those in the main Makefile.am, at least that will keep things clean.
However, if it turns out that your efforts of adding Doxygen lead to
non-recursive Automake problems also, I'll switch back to recursive make.


Best,

Lennart.

[1] http://aegis.sourceforge.net/auug97.pdf
[2] https://autotools.io/automake/nonrecursive.html


> 
> -Alvaro
> 
> 
> _______________________________________________
> genabel-devel mailing list
> genabel-devel at lists.r-forge.r-project.org
> https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/genabel-devel
> 

-- 
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
L.C. Karssen
Utrecht
The Netherlands

lennart at karssen.org
http://blog.karssen.org
GPG key ID: A88F554A
-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 213 bytes
Desc: OpenPGP digital signature
URL: <http://lists.r-forge.r-project.org/pipermail/genabel-devel/attachments/20141028/a25ff1eb/attachment.sig>