Changeset 1374


Ignore:
Timestamp:
May 31, 2009 5:38:08 PM (11 years ago)
Author:
bradbell
Message:

trunk: Add infrastructure for doxygen developer documentation

configure: automatic changes corresponding to change in configure.ac.
svn_status.sh: ignore doxydoc directory and doxyfile (see doxyfile.in).
doxyfile.in: conversion of original doxygen template to CppAD case.
*/makefile.in: remove Id property setting from all these files
configure.ac: add conversion of doxyfile.in -> doxyfile to configuration list.
build.sh: add 'build.sh doxygen' to list of options.
makefile.in: add doxyfile and doxyfile.in to distribution.
config.h: remove Id property from this file.

Location:
trunk
Files:
20 edited

Legend:

Unmodified
Added
Removed
  • trunk/build.sh

    r1369 r1374  
    374374        fi
    375375fi
     376if [ "$1" = "doxygen" ] || [ "$1" = "all" ]
     377then
     378        echo "--------------------------------------------------------------"
     379        echo "doxygen doxyfile"
     380        echo "--------------------------------------------------------------"
     381        if ! doxygen doxyfile
     382        then
     383                echo "Error: doxygen doxyfile"
     384                exit 1
     385        fi
     386        #
     387        echo "--------------------------------------------------------------"
     388        echo "pushd doxydoc/latex ; make"
     389        echo "--------------------------------------------------------------"
     390        if ! pushd doxydoc/latex
     391        then
     392                echo "Error: pushd doxydoc/latex"
     393                exit 1
     394        fi
     395        if ! make
     396        then
     397                echo "Error: pushd doxydoc/latex ; make"
     398                exit 1
     399        fi
     400        if ! popd
     401        then
     402                echo "Error: pushd doxydoc/latex ; make ; popd"
     403                exit 1
     404        fi
     405        echo "--------------------------------------------------------------"
     406        echo "mv doxydoc/latex/refman.pdf doxydoc/html/cppad.pdf"
     407        if ! mv doxydoc/latex/refman.pdf doxydoc/html/cppad.pdf
     408        then
     409                echo "Error: mv doxydoc/latex/refman.pdf doxydoc/html/cppad.pdf"
     410                exit 1
     411        fi
     412        echo "mv doxydoc/html doxydoc"
     413        if ! mv doxydoc doxydoc.$$
     414        then
     415                echo "Error: mv doxydoc doxydoc.$$"
     416                exit 1
     417        fi
     418        if ! mv doxydoc.$$/html doxydoc
     419        then
     420                echo "Error: mv doxydoc.$$/html doxydoc"
     421                exit 1
     422        fi
     423        if ! rm -r doxydoc.$$
     424        then
     425                echo "Error: rm -r doxydoc.$$"
     426                exit 1
     427        fi
     428        #
     429        if [ "$1" = "doxygen" ]
     430        then
     431                exit 0
     432        fi
     433fi
     434
    376435if [ "$1" = "test" ] || ( [ "$1" = "all" ] && [ "$2" = "test" ] )
    377436then
     
    696755echo "configure      excludes --with-*"
    697756echo "configure test includes all the possible options except PREFIX_DIR"
    698 echo "omhelp         build all the user documentation in all formats"
     757echo "omhelp         build all formats for user documentation in doc/*"
     758echo "doxygen        build developer documentation in doxydoc/*"
    699759echo "make           use make to build all of the requested targets"
    700760echo "dist           create the distribution file cppad-version.cpl.tgz"
  • trunk/configure

    r1369 r1374  
    11#! /bin/sh
    22# Guess values for system-dependent variables and create Makefiles.
    3 # Generated by GNU Autoconf 2.61 for CppAD 20090122.
     3# Generated by GNU Autoconf 2.61 for CppAD 20090531.
    44#
    55# Report bugs to <cppad@list.coin-or.org>.
     
    575575PACKAGE_NAME='CppAD'
    576576PACKAGE_TARNAME='cppad'
    577 PACKAGE_VERSION='20090122'
    578 PACKAGE_STRING='CppAD 20090122'
     577PACKAGE_VERSION='20090531'
     578PACKAGE_STRING='CppAD 20090531'
    579579PACKAGE_BUGREPORT='cppad@list.coin-or.org'
    580580
     
    12321232  # This message is too long to be a string in the A/UX 3.1 sh.
    12331233  cat <<_ACEOF
    1234 \`configure' configures CppAD 20090122 to adapt to many kinds of systems.
     1234\`configure' configures CppAD 20090531 to adapt to many kinds of systems.
    12351235
    12361236Usage: $0 [OPTION]... [VAR=VALUE]...
     
    12981298if test -n "$ac_init_help"; then
    12991299  case $ac_init_help in
    1300      short | recursive ) echo "Configuration of CppAD 20090122:";;
     1300     short | recursive ) echo "Configuration of CppAD 20090531:";;
    13011301   esac
    13021302  cat <<\_ACEOF
     
    14081408if $ac_init_version; then
    14091409  cat <<\_ACEOF
    1410 CppAD configure 20090122
     1410CppAD configure 20090531
    14111411generated by GNU Autoconf 2.61
    14121412
     
    14221422running configure, to aid debugging if configure makes a mistake.
    14231423
    1424 It was created by CppAD $as_me 20090122, which was
     1424It was created by CppAD $as_me 20090531, which was
    14251425generated by GNU Autoconf 2.61.  Invocation command line was
    14261426
     
    35823582# Define the identity of the package.
    35833583 PACKAGE='cppad'
    3584  VERSION='20090122'
     3584 VERSION='20090531'
    35853585
    35863586
     
    54585458
    54595459
    5460 ac_config_files="$ac_config_files example/test_one.sh test_more/test_one.sh doc.omh omh/install_unix.omh omh/install_windows.omh makefile ipopt_cppad/makefile example/makefile introduction/get_started/makefile introduction/exp_apx/makefile print_for/makefile speed/adolc/makefile speed/cppad/makefile speed/double/makefile speed/example/makefile speed/fadbad/makefile speed/profile/makefile speed/sacado/makefile test_more/makefile"
     5460ac_config_files="$ac_config_files doxyfile example/test_one.sh test_more/test_one.sh doc.omh omh/install_unix.omh omh/install_windows.omh makefile ipopt_cppad/makefile example/makefile introduction/get_started/makefile introduction/exp_apx/makefile print_for/makefile speed/adolc/makefile speed/cppad/makefile speed/double/makefile speed/example/makefile speed/fadbad/makefile speed/profile/makefile speed/sacado/makefile test_more/makefile"
    54615461
    54625462ac_config_commands="$ac_config_commands default-1"
     
    59815981# values after options handling.
    59825982ac_log="
    5983 This file was extended by CppAD $as_me 20090122, which was
     5983This file was extended by CppAD $as_me 20090531, which was
    59845984generated by GNU Autoconf 2.61.  Invocation command line was
    59855985
     
    60346034cat >>$CONFIG_STATUS <<_ACEOF
    60356035ac_cs_version="\\
    6036 CppAD config.status 20090122
     6036CppAD config.status 20090531
    60376037configured by $0, generated by GNU Autoconf 2.61,
    60386038  with options \\"`echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`\\"
     
    61526152    "depfiles") CONFIG_COMMANDS="$CONFIG_COMMANDS depfiles" ;;
    61536153    "cppad/config.h") CONFIG_HEADERS="$CONFIG_HEADERS cppad/config.h" ;;
     6154    "doxyfile") CONFIG_FILES="$CONFIG_FILES doxyfile" ;;
    61546155    "example/test_one.sh") CONFIG_FILES="$CONFIG_FILES example/test_one.sh" ;;
    61556156    "test_more/test_one.sh") CONFIG_FILES="$CONFIG_FILES test_more/test_one.sh" ;;
  • trunk/configure.ac

    r1369 r1374  
    1313dnl Process this file with autoconf to produce a configure script.
    1414dnl   package   version              bug-report
    15 AC_INIT(CppAD, 20090122, cppad@list.coin-or.org)
     15AC_INIT(CppAD, 20090531, cppad@list.coin-or.org)
    1616
    1717dnl By defalut disable maintainer mode when running configure;
     
    303303dnl read file.in, do its substitutions, and create file
    304304AC_CONFIG_FILES([
     305        doxyfile
    305306        example/test_one.sh
    306307        test_more/test_one.sh
     
    308309        omh/install_unix.omh
    309310        omh/install_windows.omh
     311
    310312        makefile
    311313        ipopt_cppad/makefile
  • trunk/cppad/config.h

    • Property svn:keywords deleted
    r1369 r1374  
    1 /* $Id$ */
    21/* cppad/config.h.  Generated from config.h.in by configure.  */
    32/* cppad/config.h.in.  Generated from configure.ac by autoheader.  */
     
    2524
    2625/* Define to the full name and version of this package. */
    27 #define PACKAGE_STRING "CppAD 20081123"
     26#define PACKAGE_STRING "CppAD 20090531"
    2827
    2928/* Define to the one symbol short name of this package. */
     
    3130
    3231/* Define to the version of this package. */
    33 #define PACKAGE_VERSION "20081123"
     32#define PACKAGE_VERSION "20090531"
    3433
    3534/* Version number of package */
    36 #define VERSION "20081123"
     35#define VERSION "20090531"
    3736
    3837/* Define to `__inline__' or `__inline' if that's what the C compiler
  • trunk/doxyfile.in

    r1373 r1374  
    2626# by quotes) that should identify the project.
    2727
    28 PROJECT_NAME           =
     28PROJECT_NAME           = cppad 
    2929
    3030# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     
    3232# if some version control system is used.
    3333
    34 PROJECT_NUMBER         =
     34PROJECT_NUMBER         = 20090531
    3535
    3636# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     
    3939# where doxygen was started. If left blank the current directory will be used.
    4040
    41 OUTPUT_DIRECTORY       =
     41OUTPUT_DIRECTORY       = doxydoc
    4242
    4343# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
     
    100100# operators of the base classes will not be shown.
    101101
    102 INLINE_INHERITED_MEMB  = NO
     102INLINE_INHERITED_MEMB  = YES
    103103
    104104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
     
    106106# to NO the shortest path that makes the file name unique will be used.
    107107
    108 FULL_PATH_NAMES        = YES
     108FULL_PATH_NAMES        = NO
    109109
    110110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     
    154154# description. Set this tag to YES if you prefer the old behaviour instead.
    155155
    156 MULTILINE_CPP_IS_BRIEF = NO
     156MULTILINE_CPP_IS_BRIEF = YES
    157157
    158158# If the DETAILS_AT_TOP tag is set to YES then Doxygen
     
    161161# documentation.
    162162
    163 DETAILS_AT_TOP         = NO
     163DETAILS_AT_TOP         = YES
    164164
    165165# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
     
    167167# re-implements.
    168168
    169 INHERIT_DOCS           = YES
     169INHERIT_DOCS           = NO
    170170
    171171# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
     
    222222# diagrams that involve STL classes more complete and accurate.
    223223
    224 BUILTIN_STL_SUPPORT    = NO
     224BUILTIN_STL_SUPPORT    = YES
    225225
    226226# If you use Microsoft's C++/CLI language, you should set this option to YES to
     
    248248# the \nosubgrouping command.
    249249
    250 SUBGROUPING            = YES
     250SUBGROUPING            = NO
    251251
    252252# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     
    285285# If set to NO only classes defined in header files are included.
    286286
    287 EXTRACT_LOCAL_CLASSES  = YES
     287EXTRACT_LOCAL_CLASSES  = NO
    288288
    289289# This flag is only useful for Objective-C code. When set to YES local
     
    356356# of that file.
    357357
    358 SHOW_INCLUDE_FILES     = YES
     358SHOW_INCLUDE_FILES     = NO
    359359
    360360# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
     
    368368# declaration order.
    369369
    370 SORT_MEMBER_DOCS       = YES
     370SORT_MEMBER_DOCS       = NO
    371371
    372372# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     
    403403# commands in the documentation.
    404404
    405 GENERATE_TESTLIST      = YES
     405GENERATE_TESTLIST      = NO
    406406
    407407# The GENERATE_BUGLIST tag can be used to enable (YES) or
     
    442442# in the documentation. The default is NO.
    443443
    444 SHOW_DIRECTORIES       = NO
     444SHOW_DIRECTORIES       = YES
    445445
    446446# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     
    488488# documentation.
    489489
    490 WARN_NO_PARAMDOC       = NO
     490WARN_NO_PARAMDOC       = YES
    491491
    492492# The WARN_FORMAT tag determines the format of the warning messages that
     
    514514# with spaces.
    515515
    516 INPUT                  =
     516INPUT                  = ./cppad  ./cppad/local
    517517
    518518# This tag can be used to specify the character encoding of the source files
     
    531531# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
    532532
    533 FILE_PATTERNS          =
     533FILE_PATTERNS          =  *.hpp  *.cpp
    534534
    535535# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     
    627627# VERBATIM_HEADERS is set to NO.
    628628
    629 SOURCE_BROWSER         = NO
     629SOURCE_BROWSER         = YES
    630630
    631631# Setting the INLINE_SOURCES tag to YES will include the body
     
    638638# fragments. Normal C and C++ comments will always remain visible.
    639639
    640 STRIP_CODE_COMMENTS    = YES
     640STRIP_CODE_COMMENTS    = NO
    641641
    642642# If the REFERENCED_BY_RELATION tag is set to YES (the default)
     
    644644# functions referencing it will be listed.
    645645
    646 REFERENCED_BY_RELATION = NO
     646REFERENCED_BY_RELATION = YES
    647647
    648648# If the REFERENCES_RELATION tag is set to YES (the default)
     
    650650# called/used by that function will be listed.
    651651
    652 REFERENCES_RELATION    = NO
     652REFERENCES_RELATION    = YES
    653653
    654654# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     
    657657# link to the source code.  Otherwise they will link to the documentstion.
    658658
    659 REFERENCES_LINK_SOURCE = YES
     659REFERENCES_LINK_SOURCE = NO
    660660
    661661# If the USE_HTAGS tag is set to YES then the references to source code
     
    671671# which an include is specified. Set to NO to disable this.
    672672
    673 VERBATIM_HEADERS       = YES
     673VERBATIM_HEADERS       = NO
    674674
    675675#---------------------------------------------------------------------------
     
    681681# contains a lot of classes, structs, unions or interfaces.
    682682
    683 ALPHABETICAL_INDEX     = NO
     683ALPHABETICAL_INDEX     = YES
    684684
    685685# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
     
    833833# probably better off using the HTML help feature.
    834834
    835 GENERATE_TREEVIEW      = NO
     835GENERATE_TREEVIEW      = YES
    836836
    837837# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     
    12341234# Language.
    12351235
    1236 UML_LOOK               = NO
     1236UML_LOOK               = YES
    12371237
    12381238# If set to YES, the inheritance and collaboration graphs will show the
    12391239# relations between templates and their instances.
    12401240
    1241 TEMPLATE_RELATIONS     = NO
     1241TEMPLATE_RELATIONS     = YES
    12421242
    12431243# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  • trunk/example/makefile.in

    r1341 r1374  
    156156CYGPATH_W = @CYGPATH_W@
    157157
     158# $Id: makefile.am 1370 2009-05-31 05:31:50Z bradbell $
    158159# -----------------------------------------------------------------------------
    159160# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
  • trunk/introduction/exp_apx/makefile.in

    • Property svn:keywords deleted
    r1369 r1374  
    8787CYGPATH_W = @CYGPATH_W@
    8888
     89# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    8990# -----------------------------------------------------------------------------
    9091# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-07 Bradley M. Bell
  • trunk/introduction/get_started/makefile.in

    • Property svn:keywords deleted
    r1369 r1374  
    7777CYGPATH_W = @CYGPATH_W@
    7878
     79# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    7980# -----------------------------------------------------------------------------
    8081# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-07 Bradley M. Bell
  • trunk/ipopt_cppad/makefile.in

    r1320 r1374  
    8686CYGPATH_W = @CYGPATH_W@
    8787
     88# $Id: makefile.am 1370 2009-05-31 05:31:50Z bradbell $
    8889# -----------------------------------------------------------------------------
    8990# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
  • trunk/makefile.in

    r1362 r1374  
    3333subdir = .
    3434DIST_COMMON = README $(am__configure_deps) $(nobase_myinclude_HEADERS) \
    35         $(srcdir)/doc.omh.in $(srcdir)/makefile.am \
    36         $(srcdir)/makefile.in $(top_srcdir)/configure \
    37         $(top_srcdir)/cppad/config.h.in \
     35        $(srcdir)/doc.omh.in $(srcdir)/doxyfile.in \
     36        $(srcdir)/makefile.am $(srcdir)/makefile.in \
     37        $(top_srcdir)/configure $(top_srcdir)/cppad/config.h.in \
    3838        $(top_srcdir)/omh/install_unix.omh.in \
    3939        $(top_srcdir)/omh/install_windows.omh.in AUTHORS COPYING \
     
    4747mkinstalldirs = $(install_sh) -d
    4848CONFIG_HEADER = $(top_builddir)/cppad/config.h
    49 CONFIG_CLEAN_FILES = doc.omh omh/install_unix.omh \
     49CONFIG_CLEAN_FILES = doxyfile doc.omh omh/install_unix.omh \
    5050        omh/install_windows.omh
    5151SOURCES =
     
    189189@CppAD_POSTFIX_FALSE@postfix_dir = .
    190190
     191# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    191192# -----------------------------------------------------------------------------
    192193# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
     
    433434        doc.omh \
    434435        doc.omh.in \
     436        doxyfile \
     437        doxyfile.in \
    435438        fix_aclocal.sh \
    436439        fix_makefile.sh \
     
    500503distclean-hdr:
    501504        -rm -f cppad/config.h cppad/stamp-h1
     505doxyfile: $(top_builddir)/config.status $(srcdir)/doxyfile.in
     506        cd $(top_builddir) && $(SHELL) ./config.status $@
    502507doc.omh: $(top_builddir)/config.status $(srcdir)/doc.omh.in
    503508        cd $(top_builddir) && $(SHELL) ./config.status $@
  • trunk/print_for/makefile.in

    r1251 r1374  
    7777CYGPATH_W = @CYGPATH_W@
    7878
     79# $Id: makefile.am 1370 2009-05-31 05:31:50Z bradbell $
    7980# -----------------------------------------------------------------------------
    8081# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-07 Bradley M. Bell
  • trunk/speed/adolc/makefile.in

    • Property svn:keywords deleted
    r1369 r1374  
    8282CYGPATH_W = @CYGPATH_W@
    8383
     84# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    8485# -----------------------------------------------------------------------------
    8586# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
  • trunk/speed/cppad/makefile.in

    • Property svn:keywords deleted
    r1369 r1374  
    8181CYGPATH_W = @CYGPATH_W@
    8282
     83# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    8384# -----------------------------------------------------------------------------
    8485# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
  • trunk/speed/double/makefile.in

    • Property svn:keywords deleted
    r1369 r1374  
    8181CYGPATH_W = @CYGPATH_W@
    8282
     83# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    8384# -----------------------------------------------------------------------------
    8485# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
  • trunk/speed/example/makefile.in

    • Property svn:keywords deleted
    r1369 r1374  
    8080CYGPATH_W = @CYGPATH_W@
    8181
     82# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    8283# -----------------------------------------------------------------------------
    8384# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
  • trunk/speed/fadbad/makefile.in

    • Property svn:keywords deleted
    r1369 r1374  
    8181CYGPATH_W = @CYGPATH_W@
    8282
     83# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    8384# -----------------------------------------------------------------------------
    8485# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
  • trunk/speed/profile/makefile.in

    • Property svn:keywords deleted
    r1369 r1374  
    8181CYGPATH_W = @CYGPATH_W@
    8282
     83# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    8384# -----------------------------------------------------------------------------
    8485# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
  • trunk/speed/sacado/makefile.in

    • Property svn:keywords deleted
    r1369 r1374  
    8282CYGPATH_W = @CYGPATH_W@
    8383
     84# $Id: makefile.am 1369 2009-05-31 01:31:48Z bradbell $
    8485# -----------------------------------------------------------------------------
    8586# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
  • trunk/svn_status.sh

    r1370 r1374  
    5050        -e '/^[?] *config.status$/d'                          \
    5151        -e '/^[?] *doc$/d'                                    \
     52        -e '/^[?] *doxydoc$/d'                                \
    5253        -e '/^[?] *dev$/d'                                    \
    5354        -e '/^[?] *aclocal.m4$/d'                             \
    5455        -e '/^[?] *cppad-[0-9]\{8\}.*$/d'                     \
    5556        -e '/^[?] *doc.omh$/d'                                \
     57        -e '/^[?] *doxyfile$/d'                               \
    5658        -e '/^[?] *omh\/install_unix.omh$/d'                  \
    5759        -e '/^[?] *omh\/install_windows.omh$/d'               \
  • trunk/test_more/makefile.in

    r1323 r1374  
    123123CYGPATH_W = @CYGPATH_W@
    124124
     125# $Id: makefile.am 1370 2009-05-31 05:31:50Z bradbell $
    125126# -----------------------------------------------------------------------------
    126127# CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-08 Bradley M. Bell
Note: See TracChangeset for help on using the changeset viewer.