Debian Codegraph @

fluid/documentation/convert_doxyfile

raw
1 #!/bin/sh
2 #
3 # Convert 'Doxyfile.in' to 'Doxyfile' or 'Doxybook' for doxygen docs
4 #
5 # Usage:
6 #
7 # $ sh convert_doxyfile doxygen_path input output logfile
8 #
9 # where
10 # - 'doxygen_path' is the full path to the doxygen executable or just
11 # 'doxygen' if this is in the user's PATH. If the full path is used
12 # an arbitrary doxygen executable and thus doxygen version can be used.
13 # - 'input' is the file 'Doxyfile.in' stored in Git or any other file.
14 # - 'output' is the generated doxygen file, usually either 'Doxyfile'
15 # or 'Doxybook' which will be used subsequently to generate the
16 # HTML or PDF docs, respectively.
17 #
18 # Doxygen warnings and errors are stored in 'logfile' for review.
19 #
20 #=======================================================================
21 # This script requires a posix shell and uses the following commands:
22 # 'echo', 'date', and (obviously) doxygen.
23 #=======================================================================
24
25 # doxygen command, input and output file names
26
27 DOXYGEN="$1"
28 INFILE="$2"
29 OUTFILE="$3"
30 LOGFILE="$4"
31
32 # get doxygen version
33
34 VERSION=$("$DOXYGEN" --version)
35
36 # write info header to LOGFILE
37
38 echo "$OUTFILE created by doxygen version $VERSION" > $LOGFILE
39 echo " at `date`" >> $LOGFILE
40 echo "" >> $LOGFILE
41
42 # convert doxygen file and append errors and warnings to LOGFILE
43
44 "${DOXYGEN}" -u -s - < $INFILE > $OUTFILE 2>> $LOGFILE