diff options
Diffstat (limited to 'doc/doxytag_usage.doc')
| -rw-r--r-- | doc/doxytag_usage.doc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/doxytag_usage.doc b/doc/doxytag_usage.doc index fb966fd..cbccce8 100644 --- a/doc/doxytag_usage.doc +++ b/doc/doxytag_usage.doc @@ -28,7 +28,7 @@ It has two functions: documented in external documentation. Doxytag extracts this information directly from the HTML files. This has the advantage that you do not need to have the sources from which the documentation was extracted. - If you do have the sources you can also let \c doxygen generate the + If you \e do have the sources it is better to let \c doxygen generate the tag file by putting the name of the tag file after \c GENERATE_TAGFILE in the configuration file. <li> @@ -55,7 +55,7 @@ In both cases the input of doxytag consists of a set of HTML files. Then the documentation does not need to be regenerated by \c doxygen, only \c installdox has to be run. -\par Notice: +\par Note: Because the HTML files are expected to have a certain structure, only HTML files generated with doxygen or with Qt's class browser generator can be used. Doxytag only <em>reads</em> the HTML files, @@ -87,7 +87,7 @@ doxytag -t example.tag example/html installdox script that doxygen generates (See \ref installdox_usage for more information). - Notice that this is actually a feature because if you (or someone else) + Note that this is actually a feature because if you (or someone else) moves the external documentation to a different directory or URL you can simply run the script again and all links in the HTML files will be updated. @@ -109,7 +109,7 @@ A typical example to use doxytag to generate a search index is: doxytag -s search.idx \endverbatim -\par Notice: +\par Note: In the current version of doxygen, the search index must be called \c search.idx. |