summaryrefslogtreecommitdiff
path: root/Doxyfile.in
diff options
context:
space:
mode:
authorZachary T Welch <zw@superlucidity.net>2009-11-17 06:04:03 -0800
committerZachary T Welch <zw@superlucidity.net>2009-11-17 11:42:48 -0800
commit94975c96d4f1f614e0877cac32ed5949cd0235f6 (patch)
tree476d304920c952e61322d4812dece57c4b4a5477 /Doxyfile.in
parent789d47c18097abb5ee6cc8544e0ba030000fd418 (diff)
downloadopenocd+libswd-94975c96d4f1f614e0877cac32ed5949cd0235f6.tar.gz
openocd+libswd-94975c96d4f1f614e0877cac32ed5949cd0235f6.tar.bz2
openocd+libswd-94975c96d4f1f614e0877cac32ed5949cd0235f6.tar.xz
openocd+libswd-94975c96d4f1f614e0877cac32ed5949cd0235f6.zip
update doxygen configuration to produce a PDF
A single PDF file for the developer manual allows accessing a single index, browsing, and searching. It takes significantly more time to build this way, but this patch allows others to look at the results. Migration Tip: If you have previously built the HTML Doxygen documentatation, rename your 'doxygen' directory to 'doxygen/html' to prevent needlessly rebuilding those files.
Diffstat (limited to 'Doxyfile.in')
-rw-r--r--Doxyfile.in16
1 files changed, 8 insertions, 8 deletions
diff --git a/Doxyfile.in b/Doxyfile.in
index 038f1e55..077db10a 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -38,7 +38,7 @@ PROJECT_NUMBER =
# 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.
-OUTPUT_DIRECTORY =
+OUTPUT_DIRECTORY = doxygen
# 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
@@ -770,7 +770,7 @@ GENERATE_HTML = YES
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
-HTML_OUTPUT = doxygen
+HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
@@ -981,7 +981,7 @@ FORMULA_FONTSIZE = 10
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
-GENERATE_LATEX = NO
+GENERATE_LATEX = YES
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -992,7 +992,7 @@ LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
-LATEX_CMD_NAME = latex
+LATEX_CMD_NAME = pdflatex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
@@ -1004,7 +1004,7 @@ MAKEINDEX_CMD_NAME = makeindex
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
-COMPACT_LATEX = NO
+COMPACT_LATEX = YES
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
@@ -1029,20 +1029,20 @@ LATEX_HEADER =
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
-PDF_HYPERLINKS = NO
+PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
# higher quality PDF documentation.
-USE_PDFLATEX = NO
+USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
# This option is also used when generating formulas in HTML.
-LATEX_BATCHMODE = NO
+LATEX_BATCHMODE = YES
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)