diff options
| author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2009-12-30 13:28:15 (GMT) |
|---|---|---|
| committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2009-12-30 13:28:15 (GMT) |
| commit | df4e1edf1f6abb55a811e7c4a34764f27b50e502 (patch) | |
| tree | e73e0b41d708a8ea6260e541347b464cb2e5aeaa /doc/searching.doc | |
| parent | f4fab829c8e9b4bf54c60fd85805eb008c3838ab (diff) | |
| download | Doxygen-df4e1edf1f6abb55a811e7c4a34764f27b50e502.zip Doxygen-df4e1edf1f6abb55a811e7c4a34764f27b50e502.tar.gz Doxygen-df4e1edf1f6abb55a811e7c4a34764f27b50e502.tar.bz2 | |
Release-1.6.2
Diffstat (limited to 'doc/searching.doc')
| -rw-r--r-- | doc/searching.doc | 29 |
1 files changed, 28 insertions, 1 deletions
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. + */ |