diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.win.in | 2 | ||||
| -rw-r--r-- | doc/config.doc | 18 | ||||
| -rw-r--r-- | doc/docblocks.doc | 2 | ||||
| -rw-r--r-- | doc/index.doc | 5 |
4 files changed, 23 insertions, 4 deletions
diff --git a/doc/Makefile.win.in b/doc/Makefile.win.in index fd2dbc7..0e7624d 100644 --- a/doc/Makefile.win.in +++ b/doc/Makefile.win.in @@ -13,7 +13,7 @@ # input used in their production; they are not affected by this license. all: FORCE - @xcopy /s /q ..\examples ..\html\examples + @xcopy /s /q /i ..\examples ..\html\examples set DOXYGEN_DOCDIR=. set VERSION=$(VERSION) $(DOXYGEN)\bin\doxygen diff --git a/doc/config.doc b/doc/config.doc index 8debf84..684710f 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -110,6 +110,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_generate_tagfile GENERATE_TAGFILE <li> \refitem cfg_generate_testlist GENERATE_TESTLIST <li> \refitem cfg_generate_todolist GENERATE_TODOLIST +<li> \refitem cfg_generate_treeview GENERATE_TREEVIEW <li> \refitem cfg_graphical_hierarchy GRAPHICAL_HIERARCHY <li> \refitem cfg_have_dot HAVE_DOT <li> \refitem cfg_hide_scope_names HIDE_SCOPE_NAMES @@ -162,6 +163,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_strip_from_path STRIP_FROM_PATH <li> \refitem cfg_tab_size TAB_SIZE <li> \refitem cfg_tagfiles TAGFILES +<li> \refitem cfg_treeview_width TREEVIEW_WIDTH <li> \refitem cfg_verbatim_headers VERBATIM_HEADERS <li> \refitem cfg_warn_format WARN_FORMAT <li> \refitem cfg_warn_if_undocumented WARN_IF_UNDOCUMENTED @@ -737,6 +739,22 @@ followed by the descriptions of the tags grouped by category. This tag can be used to set the number of enum values (range [1..20]) that doxygen will group on one line in the generated HTML documentation. +\anchor cfg_generate_treeview +<dt>\c GENERATE_TREEVIEW <dd> + \addindex GENERATE_TREEVIEW + If the \c GENERATE_TREEVIEW tag is set to YES, a side pannel will be + generated containing a tree-like index structure (just like the one that + is generated for HTML Help). For this to work a browser that supports + JavaScript and frames is required (for instance Netscape 4.0+ + or Internet explorer 4.0+). + +\anchor cfg_treeview_width +<dt>\c TREEVIEW_WIDTH <dd> + \addindex TREEVIEW_WIDTH + If the treeview is enabled (see \c GENERATE_TREEVIEW) then this tag can be + used to set the initial width (in pixels) of the frame in which the tree + is shown. + </dl> \subsection latex_output LaTeX related options \anchor cfg_generate_latex diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 7500eb5..8241c43 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -151,7 +151,7 @@ Here is an example of a C header named \c structcmd.h that is documented using structural commands: \verbinclude structcmd.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/structcmd/html/structcmd.h.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/structcmd/html/structcmd_h.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly diff --git a/doc/index.doc b/doc/index.doc index 39069ec..86e10bb 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -169,8 +169,9 @@ Thanks go to: <li>Jens Breitenstein, Christophe Bordeaux, Samuel Hägglund, Xet Erixon, Vlastimil Havran, Petr Prikryl, Ahmed Also Faisal, Alessandro Falappa, Kenji Nagamatsu, Francisco Oltra Thennet, Olli Korhonen, - Boris Bralo, Nickolay Semyonov, and Grzegorz Kowal for providing - translations into various languages. + Boris Bralo, Nickolay Semyonov, Richard Kim, Földvári György, + Grzegorz Kowal, and Wang Weihan + for providing translations into various languages. <li>many, many others for suggestions, patches and bug reports. </ul> */ |