[patch] ldb docs update

[Brad Hards]

On Tuesday 10 January 2006 00:31 am, simo wrote:
> Which are the requirements for generating this documentation? Which
> packages?
It should only require doxygen (at least at this stage). 

There is no requirement for dot (which is required for C++ inheritance graphs, 
so you might see that if you look at other people's autoconf magic).

The make target just needs to run "doxygen" in the top level directory (well, 
the one that contains Doxyfile). Obviously you only want to do that if you 
have doxygen.

This is the sort of autoconf magic that will be required (almost straight from 
dbus' configure.in):
AC_ARG_ENABLE(doxygen-docs,  AS_HELP_STRING([--enable-doxygen-docs],[build 
DOXYGEN documentation (requires Doxygen)], enable_doxygen_docs=$enableval, 
enable_doxygen_docs=auto)

Then in the body:
### Doxygen Documentation
AC_PATH_PROG(DOXYGEN, doxygen, no)
AC_MSG_CHECKING([whether to build Doxygen documentation])
if test x$DOXYGEN = xno ; then
    have_doxygen=no
else
    have_doxygen=yes
fi
if test x$enable_doxygen_docs = xauto ; then
    if test x$have_doxygen = xno ; then
        enable_doxygen_docs=no
    else
        enable_doxygen_docs=yes
    fi
fi

if test x$enable_doxygen_docs = xyes; then
    if test x$have_doxygen = xno; then
        AC_MSG_ERROR([Building Doxygen docs explicitly required, but Doxygen 
not found])
    fi
fi

AM_CONDITIONAL(DOXYGEN_DOCS_ENABLED, test x$enable_doxygen_docs = xyes)
AC_MSG_RESULT(yes)



Does that help?
Brad
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://lists.samba.org/archive/samba-technical/attachments/20060110/7c42bfad/attachment.bin