Refs #148. Reconfigured doxygen build environment such that it generates both a CHM and PDF file, instead of all the HTML files.
git-svn-id: https://svn.code.sf.net/p/openblt/code/trunk@258 5dc33758-31d5-4daf-9ae8-b24bf3d40d73
This commit is contained in:
parent
f68b5391ea
commit
71449427e3
|
@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8
|
||||||
# title of most generated pages and in a few other places.
|
# title of most generated pages and in a few other places.
|
||||||
# The default value is: My Project.
|
# The default value is: My Project.
|
||||||
|
|
||||||
PROJECT_NAME = "OpenBLT Bootloader"
|
PROJECT_NAME = "OpenBLT Bootloader - Reference Manual"
|
||||||
|
|
||||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
||||||
# could be handy for archiving the generated documentation or if some version
|
# could be handy for archiving the generated documentation or if some version
|
||||||
# control system is used.
|
# control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER =
|
PROJECT_NUMBER = 1.3.2
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
# for a project that appears at the top of each page and should give viewer a
|
# for a project that appears at the top of each page and should give viewer a
|
||||||
|
@ -58,7 +58,7 @@ PROJECT_LOGO = ./images/logo_openblt.png
|
||||||
# entered, it will be relative to the location where doxygen was started. If
|
# entered, it will be relative to the location where doxygen was started. If
|
||||||
# left blank the current directory will be used.
|
# left blank the current directory will be used.
|
||||||
|
|
||||||
OUTPUT_DIRECTORY = ./output/
|
OUTPUT_DIRECTORY = ./output/OpenBLT/
|
||||||
|
|
||||||
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
|
# 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 format and
|
# directories (in 2 levels) under the output directory of each output format and
|
||||||
|
@ -930,7 +930,7 @@ EXAMPLE_RECURSIVE = NO
|
||||||
# that contain images that are to be included in the documentation (see the
|
# that contain images that are to be included in the documentation (see the
|
||||||
# \image command).
|
# \image command).
|
||||||
|
|
||||||
IMAGE_PATH = ./images
|
IMAGE_PATH = ./images/OpenBLT
|
||||||
|
|
||||||
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
||||||
# invoke to filter for each input file. Doxygen will invoke the filter program
|
# invoke to filter for each input file. Doxygen will invoke the filter program
|
||||||
|
@ -1196,7 +1196,7 @@ HTML_STYLESHEET =
|
||||||
# list). For an example see the documentation.
|
# list). For an example see the documentation.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
HTML_EXTRA_STYLESHEET = ./stylesheet/openblt.css
|
HTML_EXTRA_STYLESHEET = ./stylesheet/feaser.css
|
||||||
|
|
||||||
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
||||||
# other source files which should be copied to the HTML output directory. Note
|
# other source files which should be copied to the HTML output directory. Note
|
||||||
|
@ -1328,14 +1328,14 @@ DOCSET_PUBLISHER_NAME = Publisher
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
GENERATE_HTMLHELP = NO
|
GENERATE_HTMLHELP = YES
|
||||||
|
|
||||||
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
|
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
|
||||||
# file. You can add a path in front of the file if the result should not be
|
# file. You can add a path in front of the file if the result should not be
|
||||||
# written to the html output directory.
|
# written to the html output directory.
|
||||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||||
|
|
||||||
CHM_FILE = ./../../UM_Bootloader.chm
|
CHM_FILE = ./../../../RM_OpenBLT.chm
|
||||||
|
|
||||||
# The HHC_LOCATION tag can be used to specify the location (absolute path
|
# The HHC_LOCATION tag can be used to specify the location (absolute path
|
||||||
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
|
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
|
||||||
|
@ -1343,7 +1343,7 @@ CHM_FILE = ./../../UM_Bootloader.chm
|
||||||
# The file has to be specified with full path.
|
# The file has to be specified with full path.
|
||||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||||
|
|
||||||
HHC_LOCATION = "C:/Program Files (x86)/HTML Help Workshop/hhc.exe"
|
HHC_LOCATION = "hhc.exe"
|
||||||
|
|
||||||
# The GENERATE_CHI flag controls if a separate .chi index file is generated
|
# The GENERATE_CHI flag controls if a separate .chi index file is generated
|
||||||
# (YES) or that it should be included in the master .chm file (NO).
|
# (YES) or that it should be included in the master .chm file (NO).
|
||||||
|
@ -1465,7 +1465,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
DISABLE_INDEX = NO
|
DISABLE_INDEX = YES
|
||||||
|
|
||||||
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
||||||
# structure should be generated to display hierarchical information. If the tag
|
# structure should be generated to display hierarchical information. If the tag
|
||||||
|
@ -1482,7 +1482,7 @@ DISABLE_INDEX = NO
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
GENERATE_TREEVIEW = YES
|
GENERATE_TREEVIEW = NO
|
||||||
|
|
||||||
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
|
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
|
||||||
# doxygen will group on one line in the generated HTML documentation.
|
# doxygen will group on one line in the generated HTML documentation.
|
||||||
|
@ -1596,7 +1596,7 @@ MATHJAX_CODEFILE =
|
||||||
# The default value is: YES.
|
# The default value is: YES.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
SEARCHENGINE = YES
|
SEARCHENGINE = NO
|
||||||
|
|
||||||
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
||||||
# implemented using a web server instead of a web client using Javascript. There
|
# implemented using a web server instead of a web client using Javascript. There
|
||||||
|
@ -1670,7 +1670,7 @@ EXTRA_SEARCH_MAPPINGS =
|
||||||
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
|
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
|
||||||
# The default value is: YES.
|
# The default value is: YES.
|
||||||
|
|
||||||
GENERATE_LATEX = NO
|
GENERATE_LATEX = YES
|
||||||
|
|
||||||
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
|
# 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 put in front of
|
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
|
@ -0,0 +1,15 @@
|
||||||
|
:: Batch file to generate a reference manual from the comments in the source code, with
|
||||||
|
:: Doxygen. The following tools should be installed and added to the path:
|
||||||
|
:: - DoxyGen (doxygen.exe)
|
||||||
|
:: - Graphviz (dot.exe)
|
||||||
|
:: - MikTex (pdflatex.exe)
|
||||||
|
:: - HTML Help Workshop compiler (hhc.exe)
|
||||||
|
if exist ..\RM_OpenBLT.pdf del ..\RM_OpenBLT.pdf
|
||||||
|
if exist ..\RM_OpenBLT.chm del ..\RM_OpenBLT.chm
|
||||||
|
doxygen.exe DoxyfileOpenBLT
|
||||||
|
call .\output\OpenBLT\latex\make.bat
|
||||||
|
call copy .\output\OpenBLT\latex\refman.pdf ..\RM_OpenBLT.pdf
|
||||||
|
:: Remove the comment on the next line to automatically open the generated PDF file
|
||||||
|
:: call start "C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe" ..\RM_OpenBLT.pdf
|
||||||
|
:: Remove the comment on the next line to automatically open the generated CHM file
|
||||||
|
:: start .\..\RM_OpenBLT.chm
|
|
@ -1,4 +0,0 @@
|
||||||
"C:\Program Files\doxygen\bin\doxygen.exe" Doxyfile
|
|
||||||
start .\output\index.html
|
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
.image
|
||||||
|
{
|
||||||
|
text-align: left;
|
||||||
|
}
|
Loading…
Reference in New Issue