Release-1.5.7

3 files changed, 102 insertions, 52 deletions

diff --git a/doc/config.doc b/doc/config.doc
index 3768df7..e4e1c4a 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -88,7 +88,6 @@ followed by the descriptions of the tags grouped by category.
 \refitem cfg_dot_transparent DOT_TRANSPARENT
 \refitem cfg_dotfile_dirs DOTFILE_DIRS
 \refitem cfg_doxyfile_encoding DOXYFILE_ENCODING
-\refitem cfg_doxygen2qthelp_loc DOXYGEN2QTHELP_LOC
 \refitem cfg_enable_preprocessing ENABLE_PREPROCESSING
 \refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE
 \refitem cfg_enabled_sections ENABLED_SECTIONS
@@ -125,6 +124,7 @@ followed by the descriptions of the tags grouped by category.
 \refitem cfg_generate_legend GENERATE_LEGEND
 \refitem cfg_generate_man GENERATE_MAN
 \refitem cfg_generate_perlmod GENERATE_PERLMOD
+\refitem cfg_generate_qhp GENERATE_QHP
 \refitem cfg_generate_rtf GENERATE_RTF
 \refitem cfg_generate_tagfile GENERATE_TAGFILE
 \refitem cfg_generate_testlist GENERATE_TESTLIST
@@ -191,9 +191,10 @@ followed by the descriptions of the tags grouped by category.
 \refitem cfg_predefined PREDEFINED
 \refitem cfg_project_name PROJECT_NAME
 \refitem cfg_project_number PROJECT_NUMBER
+\refitem cfg_qhp_namespace QHP_NAMESPACE
+\refitem cfg_qhp_virtual_folder QHP_VIRTUAL_FOLDER
+\refitem cfg_qhg_location QHG_LOCATION
 \refitem cfg_qt_autobrief QT_AUTOBRIEF
-\refitem cfg_qthelp_config QTHELP_CONFIG
-\refitem cfg_qthelp_file QTHELP_FILE
 \refitem cfg_quiet QUIET
 \refitem cfg_recursive RECURSIVE
 \refitem cfg_referenced_by_relation REFERENCED_BY_RELATION
@@ -1264,25 +1265,14 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
  Setting this tag to \c NO will become obsolete in the future, since I only
  intent to support and test the aligned representation.
 
-
-\anchor cfg_generate_htmlhelp
-<dt>\c GENERATE_HTMLHELP <dd>
- \addindex GENERATE_HTMLHELP
- If the \c GENERATE_HTMLHELP tag is set to \c YES then
- doxygen generates three additional HTML index files: 
- \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a 
- project file that can be read by 
- <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">
- Microsoft's HTML Help Workshop</a>
- on Windows.
-
- The HTML Help Workshop contains a compiler that can convert all HTML output 
- generated by doxygen into a single compiled HTML file (.chm). Compiled
- HTML files are now used as the Windows 98 help format, and will replace
- the old Windows help format (.hlp) on all Windows platforms in the future.
- Compressed HTML files also contain an index, a table of contents,
- and you can search for words in the documentation.
- The HTML workshop also contains a viewer for compressed HTML files.
+\anchor cfg_html_dynamic_sections
+<dt>\c HTML_DYNAMIC_SECTIONS <dd>
+ \addindex HTML_DYNAMIC_SECTIONS
+ If the \c HTML_DYNAMIC_SECTIONS tag is set to \c YES then the generated HTML
+ documentation will contain sections that can be hidden and shown after the
+ page has loaded. For this to work a browser that supports
+ JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+ Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 
 
 \anchor cfg_generate_docset
 <dt>\c GENERATE_DOCSET <dd>
@@ -1314,14 +1304,25 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
  reverse domain-name style string, e.g. <code>com.mycompany.MyDocSet</code>. 
  Doxygen will append <code>.docset</code> to the name.
 
-\anchor cfg_html_dynamic_sections
-<dt>\c HTML_DYNAMIC_SECTIONS <dd>
- \addindex HTML_DYNAMIC_SECTIONS
- If the \c HTML_DYNAMIC_SECTIONS tag is set to \c YES then the generated HTML
- documentation will contain sections that can be hidden and shown after the
- page has loaded. For this to work a browser that supports
- JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
- Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 
+
+\anchor cfg_generate_htmlhelp
+<dt>\c GENERATE_HTMLHELP <dd>
+ \addindex GENERATE_HTMLHELP
+ If the \c GENERATE_HTMLHELP tag is set to \c YES then
+ doxygen generates three additional HTML index files: 
+ \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a 
+ project file that can be read by 
+ <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">
+ Microsoft's HTML Help Workshop</a>
+ on Windows.
+
+ The HTML Help Workshop contains a compiler that can convert all HTML output 
+ generated by doxygen into a single compiled HTML file (.chm). Compiled
+ HTML files are now used as the Windows 98 help format, and will replace
+ the old Windows help format (.hlp) on all Windows platforms in the future.
+ Compressed HTML files also contain an index, a table of contents,
+ and you can search for words in the documentation.
+ The HTML workshop also contains a viewer for compressed HTML files.
 
 \anchor cfg_chm_file 
 <dt>\c CHM_FILE <dd>
@@ -1339,6 +1340,59 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
   the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
   the HTML help compiler on the generated index.hhp.
 
+\anchor cfg_generate_chi
+<dt>\c GENERATE_CHI <dd>
+ \addindex GENERATE_CHI
+ If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c GENERATE_CHI flag
+ controls if a separate .chi index file is generated (<code>YES</code>) or that
+ it should be included in the master .chm file (<code>NO</code>).
+
+\anchor cfg_binary_toc
+<dt>\c BINARY_TOC <dd>
+ \addindex BINARY_TOC
+ If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c BINARY_TOC flag
+ controls whether a binary table of contents is generated (<code>YES</code>) or a
+ normal table of contents (<code>NO</code>) in the .chm file.
+
+\anchor cfg_toc_expand
+<dt>\c TOC_EXPAND <dd>
+ \addindex TOC_EXPAND
+ The \c TOC_EXPAND flag can be set to YES to add extra items for 
+ group members to the table of contents of the HTML help documentation 
+ and to the tree view.
+
+\anchor cfg_generate_qhp
+<dt>\c GENERATE_QHP <dd>
+ \addindex GENERATE_QHP
+ If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE
+ and QHP_VIRTUAL_FOLDER are set, an additional index file will
+ be generated that can be used as input for Qt's qhelpgenerator
+ to generate a Qt Compressed Help (.qch) of the generated HTML
+ documentation.
+
+\anchor cfg_qhp_namespace
+<dt>\c QHP_NAMESPACE <dd>
+ \addindex QHP_NAMESPACE
+ The QHP_NAMESPACE tag specifies the namespace to use when generating
+ Qt Help Project output. For more information please see
+ <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
+
+\anchor cfg_qhp_virtual_folder
+<dt>\c QHP_VIRTUAL_FOLDER <dd>
+ \addindex QHP_VIRTUAL_FOLDER
+ The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when
+ generating Qt Help Project output. For more information please see
+ <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
+
+\anchor cfg_qhg_location
+<dt>\c QHG_LOCATION <dd>
+ \addindex QHG_LOCATION
+ If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+ be used to specify the location of Qt's qhelpgenerator.
+ If non-empty doxygen will try to run qhelpgenerator on the generated
+ .qhp file.
+
+<!--
 \anchor cfg_qthelp_file 
 <dt>\c QTHELP_FILE <dd>
  \addindex QTHELP_FILE
@@ -1360,27 +1414,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
   can be used to specify the location (absolute path including file name) of 
   the doxygen2qthelp tool. If non-empty doxygen will try to run doxygen2qthelp 
   on the generated index.hhp.
-
-\anchor cfg_generate_chi
-<dt>\c GENERATE_CHI <dd>
- \addindex GENERATE_CHI
- If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c GENERATE_CHI flag
- controls if a separate .chi index file is generated (<code>YES</code>) or that
- it should be included in the master .chm file (<code>NO</code>).
-
-\anchor cfg_binary_toc
-<dt>\c BINARY_TOC <dd>
- \addindex BINARY_TOC
- If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c BINARY_TOC flag
- controls whether a binary table of contents is generated (<code>YES</code>) or a
- normal table of contents (<code>NO</code>) in the .chm file.
-
-\anchor cfg_toc_expand
-<dt>\c TOC_EXPAND <dd>
- \addindex TOC_EXPAND
- The \c TOC_EXPAND flag can be set to YES to add extra items for 
- group members to the table of contents of the HTML help documentation 
- and to the tree view.
+-->
 
 \anchor cfg_disable_index
 <dt>\c DISABLE_INDEX <dd>
diff --git a/doc/install.doc b/doc/install.doc
index d82f217..41961ec 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -586,6 +586,11 @@ you need the Microsoft HTML help workshop.
 You can download it from 
 <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">Microsoft</a>.
 
+If you want to produce Qt Compressed Help files (see \ref 
+cfg_qhg_location "QHG_LOCATION") in the config file, then 
+you need qhelpgenerator which is part of Qt. 
+You can download Qt from <a href="http://trolltech.com/downloads/">Trolltech Downloads</a>.
+
 In order to generate PDF output or use scientific formulas you will also need to
 install <a href="http://en.wikipedia.org/wiki/LaTeX">LaTeX</a> and 
 <a href="http://en.wikipedia.org/wiki/Ghostscript">Ghostscript</a>. 
@@ -653,6 +658,12 @@ features:
     You can download it from 
     <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">Microsoft</a>.
 
+<li>If you want to produce Qt Compressed Help files (see \ref 
+    cfg_qhelgenerator_loc "QHG_LOCATION") in the config file,
+    then you need qhelpgenerator which is part of Qt. 
+    You can download Qt from
+    <a href="http://trolltech.com/downloads/">Trolltech Downloads</a>.
+
 <li><a href="http://www.graphviz.org/">
     the Graph visualization toolkit version 1.8.10</a><br>
     \latexonly(see {\tt http://www.graphviz.org/})\endlatexonly.
@@ -674,7 +685,7 @@ open-source tools:
 <li>Perl version 5.8.1
 <li>VIM version 6.2
 <li>Firefox 1.5
-<li>Troll Tech's tmake version 1.3 (included in the distribution) 
+<li>Trolltech's tmake version 1.3 (included in the distribution) 
 <li>teTeX version 2.0.2
 <li>CVS 1.12.12
 </ul>
diff --git a/doc/output.doc b/doc/output.doc
index 6e87ce7..5777ca2 100644
--- a/doc/output.doc
+++ b/doc/output.doc
@@ -35,6 +35,8 @@ The following output formats are \e directly supported by doxygen:
 <dt><b>XML</b>
 <dd>Generated if \c GENERATE_XML is set to \c YES in the configuration file.<p>
     Note that the XML output is still under development. 
+<dt><b>Qt Help Project (.qhp)</b>
+<dd>Generated if \c GENERATE_QHP is set to \c YES in the configuration file.
 </dl>
 
 The following output formats are \e indirectly supported by doxygen:
@@ -42,6 +44,9 @@ The following output formats are \e indirectly supported by doxygen:
 <dt><b>Compiled HTML Help</b> (a.k.a. Windows 98 help)
 <dd>Generated by Microsoft's HTML Help workshop from the HTML output if 
     \c GENERATE_HTMLHELP is set to \c YES.
+<dt><b>Qt Compressed Help (.qch)</b>
+<dd>Generated by Qt's qhelpgenerator tool from the HTML output if 
+    \c GENERATE_QHP is set to \c YES.
 <dt><b>PostScript</b>
 <dd>Generated from the \f$\mbox{\LaTeX}\f$ output by 
     running <code>make ps</code> in the output directory.