Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
swdev:howto:create_and_use_html_help_.chm_files [2010/07/08 14:08] smayr |
swdev:howto:create_and_use_html_help_.chm_files [2020/05/08 17:18] (current) ajdavis [Setup Doxygen] |
||
---|---|---|---|
Line 7: | Line 7: | ||
===Setup Doxygen=== | ===Setup Doxygen=== | ||
* [[http:// | * [[http:// | ||
- | * Download Doxygen files from http:// | + | * Make sure ezfit5/ |
- | * Download pas2dox from http:// | + | * <del>Download Doxygen files from http:// |
- | * Copy pas2dox executable into the same folder where doxygen was installed (by default '' | + | * <del>Download pas2dox from http:// |
+ | * <del>Copy pas2dox executable into the same folder where doxygen was installed (by default '' | ||
* Verify that the following preprocessor setting is enabled in the doxygen configuration file (for example, proj.cfg) used in a Delphi/ | * Verify that the following preprocessor setting is enabled in the doxygen configuration file (for example, proj.cfg) used in a Delphi/ | ||
<code delphi> | <code delphi> | ||
Line 16: | Line 17: | ||
... | ... | ||
</ | </ | ||
+ | |||
===Doxygen Configuration=== | ===Doxygen Configuration=== | ||
* Generate a configuration file (such as proj.cfg) by calling doxygen with the -g option: | * Generate a configuration file (such as proj.cfg) by calling doxygen with the -g option: | ||
Line 117: | Line 119: | ||
doxygen < | doxygen < | ||
</ | </ | ||
- | |||
=== Generating PDF File === | === Generating PDF File === | ||
Download and install the required software: | Download and install the required software: | ||
* Ghostscript (http:// | * Ghostscript (http:// | ||
- | * REM - MiKTeX (http:// | + | * MiKTeX (http:// |
+ | |||
+ | Create default Makefile (here it is called '' | ||
+ | <code dos> | ||
+ | all: clean refman.dvi | ||
+ | |||
+ | ps: refman.ps | ||
+ | |||
+ | pdf: refman.pdf | ||
+ | |||
+ | ps_2on1: refman_2on1.ps | ||
+ | |||
+ | pdf_2on1: refman_2on1.pdf | ||
+ | |||
+ | refman.ps: refman.dvi | ||
+ | C: | ||
+ | |||
+ | refman.pdf: refman.ps | ||
+ | " | ||
+ | |||
+ | refman.dvi: refman.tex doxygen.sty | ||
+ | echo " | ||
+ | C: | ||
+ | echo " | ||
+ | C: | ||
+ | echo " | ||
+ | C: | ||
+ | |||
+ | refman_2on1.ps: | ||
+ | C: | ||
+ | |||
+ | refman_2on1.pdf: | ||
+ | " | ||
+ | |||
+ | clean: | ||
+ | del -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.pdf | ||
+ | </ | ||
Run a batch file: | Run a batch file: | ||
- | < | + | < |
REM ---------------------------------------------------------- | REM ---------------------------------------------------------- | ||
REM script: make.bat | REM script: make.bat | ||
+ | REM date : 2006 jun | ||
+ | REM programmer: Siegwart Mayr | ||
REM Description: | REM Description: | ||
REM Make HTML, CHM, and PDF versions of the documentation | REM Make HTML, CHM, and PDF versions of the documentation | ||
Line 143: | Line 182: | ||
doxygen proj.cfg | doxygen proj.cfg | ||
- | rem @echo --- create PDF document version --- | + | @echo --- create PDF document version --- |
copy /Y LatexMakefile latex\Makefile | copy /Y LatexMakefile latex\Makefile | ||
@cd latex | @cd latex | ||
- | make all | + | |
- | make ps | + | REM --- Create PDF using Makefile (Optional) --- |
- | make pdf | + | REM make all |
- | make ps_2on1 | + | REM make ps |
- | make pdf_2on1 | + | REM make pdf |
+ | REM make ps_2on1 | ||
+ | REM make pdf_2on1 | ||
+ | |||
+ | REM --- Creating PDF using commands directly --- | ||
+ | @echo " | ||
+ | C: | ||
+ | @echo " | ||
+ | C: | ||
+ | @echo " | ||
+ | C: | ||
+ | @echo " | ||
+ | C: | ||
+ | C: | ||
+ | " | ||
@cd .. | @cd .. | ||
Line 157: | Line 211: | ||
start html\UserDoc.CHM | start html\UserDoc.CHM | ||
start latex\refman.pdf | start latex\refman.pdf | ||
- | start latex\refman_2on1.pdf | + | rem start latex\refman_2on1.pdf |
+ | |||
+ | @pause | ||
</ | </ | ||
Line 283: | Line 339: | ||
#include ctxhelp | #include ctxhelp | ||
</ | </ | ||
+ | |||
* Create a batch file to add the context information: | * Create a batch file to add the context information: |