#17 Documentation generation uses obsolete doc++

open-accepted
None
5
2006-04-09
2005-05-03
No

doc++, used to extract documentation from source code,
is obsolete. It has been replaced by Doxygen.

Please could you update the source to use Doxygen?

Thanks,
Roger

Discussion

  • Rémi Turboult

    Rémi Turboult - 2006-04-09
    • assigned_to: nobody --> r3mi
    • status: open --> open-accepted
     
  • Rémi Turboult

    Rémi Turboult - 2006-04-14

    Logged In: YES
    user_id=865654

    in progress

     
  • Anonymous - 2006-05-09

    Logged In: YES
    user_id=116840

    Many thanks for taking a look at this. If you need any help
    with doxygen, please let me know. I would suggest putting
    in configure.ac:

    AC_PATH_PROG([DOXYGEN], [doxygen])

    You can also generate the doxygen config file with
    AC_CONFIG_FILE (to substitute in paths). For example:

    PROJECT_NUMBER = @VERSION@
    STRIP_FROM_PATH = @top_srcdir@
    INPUT = @top_srcdir@/path/to/sources

    libupnp is the last package using doc++ in Debian, and we
    are keen to remove it, because of the problems it is causing
    due to no longer being maintained.

    Many thanks,
    Roger

     
  • Anonymous - 2006-05-09

    Logged In: YES
    user_id=116840

    I also forgot to mention. In configure.ac:

    AM_MAINTAINER_MODE
    AC_PATH_PROG([DOXYGEN], [doxygen])
    AM_CONDITIONAL([USE_DOXYGEN], [test -n "$DOXYGEN"])

    Maintainer mode is used to ensure the docs aren't usually
    built by end users.

    In your Makefile.am (example for schroot project; just
    replace schroot with your library name):

    if MAINTAINER_MODE
    all-local: schroot
    endif

    if USE_DOXYGEN
    schroot: schroot-stamp
    else
    schroot:
    endif

    schroot-stamp: schroot.dox $(top_srcdir)/configure
    $(RM) -rf schroot/html
    $(DOXYGEN) schroot.dox
    touch $@

    CLEANFILES = \ schroot.log

    maintainer-clean-local:
    $(RM) -r schroot

    MAINTAINERCLEANFILES = \ schroot-stamp

    EXTRA_DIST = \ schroot \ schroot-stamp

    .PHONY: schroot

     
  • Anonymous - 2006-06-16

    Logged In: YES
    user_id=116840

    Is any progress being made with this?

     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks