lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Keep only one doxygen file. We keep the file build by Regis as it works both with Eclipse and with perl script, however we rename it to have a config file name that match the script name.

Browse Source
This commit is contained in:
Laurent Destailleur 2009-11-13 05:36:13 +00:00
parent 01eb1faba9
commit 2d2b11c78e
2 changed files with 190 additions and 242 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/dev/dolibarr-doxygen-build.pl
View File

@ -13,22 +13,21 @@ $DIR =~ s/([^\/\\])[\\\/]+$/$1/;
$OPTIONS=""; $OPTIONS="";
#$OPTIONS="-d Preprocessor"; #$OPTIONS="-d Preprocessor";
$CONFFILE="doc/dev/dolibarr-doxygen.conf"; $CONFFILE="dolibarr-doxygen.doxyfile";
#$CONFFILE="doc/dev/dolibarr-doxygen2.conf";
use Cwd; use Cwd;
my $dir = getcwd; my $dir = getcwd;
print "Current dir is: $dir\n"; print "Current dir is: $dir\n";
print "Running dir for doxygen must be: $DIR/../..\n"; print "Running dir for doxygen must be: $DIR\n";
if (! -s "doc/dev/dolibarr-doxygen.conf") if (! -s $CONFFILE)
{ {
print "Error: current directory for building Dolibarr doxygen documentation is not correct.\n"; print "Error: current directory for building Dolibarr doxygen documentation is not correct.\n";
print "\n"; print "\n";
print "Change your current directory then to launch the script, run:\n"; print "Change your current directory then, to launch the script, run:\n";
print '> perl doc\dev\dolibarr-doxygen-build.pl (on Windows)'."\n"; print '> perl dolibarr-doxygen-build.pl (on Windows)'."\n";
print '> perl doc/dev/dolibarr-doxygen-build.pl (on Linux or BSD)'."\n"; print '> perl dolibarr-doxygen-build.pl (on Linux or BSD)'."\n";
sleep 4; sleep 4;
exit 1; exit 1;
} }

65
doc/dev/dolibarr-doxygen.conf → doc/dev/dolibarr-doxygen.doxyfile Normal file → Executable file
View File

@ -1,4 +1,4 @@
# Doxyfile 1.5.5 # Doxyfile 1.6.1
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project # doxygen (www.doxygen.org) for a project
@ -38,7 +38,7 @@ PROJECT_NUMBER = 2.7.0
# If a relative path is entered, it will be relative to the location # If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used. # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = doc/dev OUTPUT_DIRECTORY = ../../doc/dev
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output # 4096 sub-directories (in 2 levels) under the output directory of each output
@ -155,13 +155,6 @@ QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO MULTILINE_CPP_IS_BRIEF = NO
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
# will output the detailed description near the top, like JavaDoc.
# If set to NO, the detailed description appears after the member
# documentation.
DETAILS_AT_TOP = YES
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it # member inherits the documentation from any documented member that it
# re-implements. # re-implements.
@ -518,7 +511,7 @@ WARN_LOGFILE = doxygen_warnings.log
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = htdocs INPUT = ../../htdocs
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -536,8 +529,7 @@ INPUT_ENCODING = ISO-8859-1
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.php \ FILE_PATTERNS = *.php *.pl
*.pl
# The RECURSIVE tag can be used to turn specify whether or not subdirectories # The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO. # should be searched for input files as well. Possible values are YES and NO.
@ -549,48 +541,7 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a # excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag. # subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = mssql \ EXCLUDE = mssql mysql pgsql CVS build dev doc documents htdocs/conf/conf.php htdocs/includes/adodbtime htdocs/includes/artichow htdocs/includes/barcode htdocs/includes/fckeditor htdocs/includes/fpdf htdocs/includes/geoip htdocs/includes/magpierss htdocs/includes/nusoap htdocs/includes/pear htdocs/includes/php_excelreader htdocs/includes/php_writeexcel htdocs/includes/phplot htdocs/includes/phplot5 htdocs/includes/pwc htdocs/includes/scriptaculous htdocs/includes/simplemail htdocs/includes/smarty htdocs/includes/smtps htdocs/includes/vcard htdocs/avoir htdocs/document htdocs/documents htdocs/lolix htdocs/postnuke htdocs/rapport htdocs/telephonie htdocs/voyage htdocs/oscommerce_ws/ws_client_demo htdocs/oscommerce_ws/ws_server scripts/addons scripts/courrier scripts/lolix scripts/energie
mysql \
pgsql \
CVS \
build \
dev \
doc \
documents \
htdocs/conf/conf.php \
htdocs/includes/adodbtime \
htdocs/includes/artichow \
htdocs/includes/barcode \
htdocs/includes/fckeditor \
htdocs/includes/fpdf \
htdocs/includes/geoip \
htdocs/includes/magpierss \
htdocs/includes/nusoap \
htdocs/includes/pear \
htdocs/includes/php_excelreader \
htdocs/includes/php_writeexcel \
htdocs/includes/phplot \
htdocs/includes/phplot5 \
htdocs/includes/pwc \
htdocs/includes/scriptaculous \
htdocs/includes/simplemail \
htdocs/includes/smarty \
htdocs/includes/smtps \
htdocs/includes/vcard \
htdocs/avoir \
htdocs/document \
htdocs/documents \
htdocs/lolix \
htdocs/postnuke \
htdocs/rapport \
htdocs/telephonie \
htdocs/voyage \
htdocs/oscommerce_ws/ws_client_demo \
htdocs/oscommerce_ws/ws_server \
scripts/addons \
scripts/courrier \
scripts/lolix \
scripts/energie
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded # directories that are symbolic links (a Unix filesystem feature) are excluded
@ -604,9 +555,7 @@ EXCLUDE_SYMLINKS = YES
# against the file with absolute path, so to exclude all test directories # against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/* # for example use the pattern */test/*
EXCLUDE_PATTERNS = */CVS/* \ EXCLUDE_PATTERNS = */CVS/* *google* *pibarcode*
*google* \
*pibarcode*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the # (namespaces, classes, functions, etc.) that should be excluded from the
@ -1261,7 +1210,7 @@ HIDE_UNDOC_RELATIONS = YES
# toolkit from AT&T and Lucent Bell Labs. The other options in this section # toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default) # have no effect if this option is set to NO (the default)
HAVE_DOT = YES HAVE_DOT = NO
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and # will generate a graph for each documented class showing the direct and