Release-1.6.2

3 files changed, 75 insertions, 11 deletions

diff --git a/doc/config.doc b/doc/config.doc
index b657883..455ac61 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -91,6 +91,7 @@ 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_eclipse_doc_id ECLIPSE_DOC_ID
 \refitem cfg_enable_preprocessing ENABLE_PREPROCESSING
 \refitem cfg_enabled_sections ENABLED_SECTIONS
 \refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE
@@ -123,6 +124,7 @@ followed by the descriptions of the tags grouped by category.
 \refitem cfg_generate_chi GENERATE_CHI
 \refitem cfg_generate_deprecatedlist GENERATE_DEPRECIATEDLIST
 \refitem cfg_generate_docset GENERATE_DOCSET
+\refitem cfg_generate_eclipsehelp GENERATE_ECLIPSEHELP
 \refitem cfg_generate_html GENERATE_HTML
 \refitem cfg_generate_htmlhelp GENERATE_HTMLHELP
 \refitem cfg_generate_latex GENERATE_LATEX
@@ -1455,6 +1457,28 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
  If non-empty doxygen will try to run qhelpgenerator on the generated
  .qhp file.
 
+\anchor cfg_generate_eclipsehelp
+<dt>\c GENERATE_ECLIPSEHELP <dd>
+ \addindex GENERATE_ECLIPSEHELP
+ If the \c GENERATE_ECLIPSEHELP tag is set to \c YES, additional index files  
+ will be generated, which together with the HTML files, form an Eclipse help  
+ plugin. 
+
+ To install this plugin and make it available under the help contents 
+ menu in Eclipse, the contents of the directory containing the HTML and XML 
+ files needs to be copied into the plugins directory of eclipse. The name of 
+ the directory within the plugins directory should be the same as 
+ the \ref cfg_eclipse_doc_id "ECLIPSE_DOC_ID" value. 
+
+ After copying Eclipse needs to be restarted before the help appears.
+
+\anchor cfg_eclipse_doc_id
+<dt>\c ECLIPSE_DOC_ID <dd>
+ \addindex ECLIPSE_DOC_ID
+ A unique identifier for the eclipse help plugin. When installing the plugin 
+ the directory name containing the HTML and XML files should also have 
+ this name. Each documentation set should have its own identifier.
+
 \anchor cfg_searchengine
 <dt>\c SEARCHENGINE <dd>
  \addindex SEARCHENGINE
diff --git a/doc/index.doc b/doc/index.doc
index 7996f78..8633331 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -153,18 +153,31 @@ that use doxygen.
 \latexonly
 list of projects that use doxygen (see {\tt http://www.doxygen.org/projects.html}).
 \endlatexonly
-If you know other projects, let me know and I'll add them. 
+If you know other projects, let <a href="mailto:dimitri@stack.nl?subject=New%20project%20using%20Doxygen">me</a> 
+know and I'll add them. 
+
+<h2>Commercial Support</h2>
+
+I'm currently investigating the possibilities of providing
+commercial support for doxygen. The forms of support I'm thinking of
+are: 
+<ul>
+<li>implementing features, 
+<li>fixing bugs, 
+<li>providing priority help in answering questions. 
+</ul>
+To get a better understanding of the feasibility,
+please let <a href="mailto:dimitri@stack.nl?subject=Doxygen%20Commercial%20Support">me</a> know if you 
+have a need for this type (or another type)
+of doxygen related commercial support.
 
 <h2>Future work</h2>
-Although doxygen is used successfully by a lot of people already, 
-there is always room for improvement. Therefore, I have compiled a 
-\htmlonly
-<a href="http://www.doxygen.org/todo.html">todo/wish list</a>
-\endhtmlonly 
-\latexonly
-todo/wish list (see {\tt http://www.doxygen.org/todo.html})
-\endlatexonly
-of possible and/or requested enhancements. 
+Although doxygen is successfully used by large number of companies and 
+open source projects already, there is always room for improvement. 
+<p>
+You can submit enhancement requests in
+<a href="https://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=enhancement">the bug tracker</a>.
+Make sure the severity of the bug report is set to "enhancement".
 
 <h2>Acknowledgements</h2>
 \addindex acknowledgements
diff --git a/doc/searching.doc b/doc/searching.doc
index 62f8971..03cd2b7 100644
--- a/doc/searching.doc
+++ b/doc/searching.doc
@@ -25,7 +25,7 @@ HTML browsers by default have no search capabilities that work across multiple
 pages, so either doxygen or external tools need to help to facilitate 
 this feature.
 
-Doxygen has 5 different ways to add searching to the HTML output, each of which
+Doxygen has 6 different ways to add searching to the HTML output, each of which
 has its own advantages and disadvantages:
 
 <h2>1. Client side searching</h2>
@@ -128,4 +128,31 @@ has its own advantages and disadvantages:
    each user, or distributing the Qt help assistant along with 
    the documentation, which is complicated by the fact that it is not
    available as a separate package at this moment.
+
+<h2>6. Eclipse Help Plugin</h2>
+   If you use eclipse, you can embed the documentation generated by
+   doxygen as a help plugin. It will then appear as a topic in the help 
+   browser that can be started from "Help contents" in the Help menu.
+   Eclipse will generate a search index for the documentation when you
+   first search for an keyword.
+
+   To enable the help plugin set 
+   \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSE_HELP" to \c YES,
+   and define a unique identifier for your project via
+   \ref cfg_eclipse_doc_id "ECLIPSE_DOC_ID", i.e:
+\verbatim
+   GENERATE_ECLIPSE_HELP = YES
+   ECLIPSE_DOC_ID        = com.yourcompany.yourproject
+\endverbatim
+   then create the \c com.yourcompany.yourproject directory (so with
+   the same name as the value of \c ECLIPSE_DOC_ID) in the 
+   \c plugin directory of eclipse and after doxygen completes copy
+   to contents of the help output directory to 
+   the \c com.yourcompany.yourproject directory.
+   Then restart eclipse to make let it find the new plugin.
+
+   The eclipse help plugin provides similar functionality as the
+   Qt compressed help or CHM output, but it does require that Eclipse is
+   installed and running.
+
 */