summaryrefslogtreecommitdiffstats
path: root/doc/config.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/config.doc')
-rw-r--r--doc/config.doc17
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/config.doc b/doc/config.doc
index 6a89490..73ee99c 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -1313,11 +1313,20 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
\anchor cfg_generate_treeview
<dt>\c GENERATE_TREEVIEW <dd>
\addindex GENERATE_TREEVIEW
- If the \c GENERATE_TREEVIEW tag is set to YES, a side panel will be
- generated containing a tree-like index structure (just like the one that
+ The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+ structure should be generated to display hierarchical information.
+ If the tag value is set to FRAME, a side panel 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 Mozilla 1.0+, Netscape 6.0+
- or Internet explorer 5.0+ or Konqueror).
+ JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+ Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+ probably better off using the HTML help feature. Other possible values
+ for this tag are: \c HIERARCHIES, which will generate the Groups, Directories,
+ and Class Hiererachy pages using a tree view instead of an ordered list;
+ ALL, which combines the behavior of \c FRAME and \c HIERARCHIES, and \c NONE,
+ which disables this behavior completely. For backwards compatibility
+ with previous releases of Doxygen, the values YES and NO are equivalent
+ to FRAME and NONE respectively.
\anchor cfg_treeview_width
<dt>\c TREEVIEW_WIDTH <dd>