summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-05-22 18:35:23 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-05-22 18:35:23 (GMT)
commitf38608d4bec002a5051c860a599dd4d5229a9671 (patch)
tree699a18c9a8c098fc845ba00c7eb093c73b497c5c /doc
parent8013b5fe71402e6c6bfd867e348b6cad73bd7386 (diff)
downloadDoxygen-f38608d4bec002a5051c860a599dd4d5229a9671.zip
Doxygen-f38608d4bec002a5051c860a599dd4d5229a9671.tar.gz
Doxygen-f38608d4bec002a5051c860a599dd4d5229a9671.tar.bz2
Release-1.1.3-20000522
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc9
-rw-r--r--doc/faq.doc10
-rw-r--r--doc/starting.doc17
3 files changed, 29 insertions, 7 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index b0fdee8..c715160 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -87,6 +87,7 @@ documentation:
<li> \refitem cmdmainpage \mainpage
<li> \refitem cmdname \name
<li> \refitem cmdnamespace \namespace
+<li> \refitem cmdnosubgrouping \nosubgrouping
<li> \refitem cmdoverload \overload
<li> \refitem cmdpage \page
<li> \refitem cmdpar \par
@@ -367,6 +368,14 @@ See section \ref memgroup for an example.
namespace with name \<name\>.
<hr>
+\subsection cmdnosubgrouping \nosubgrouping
+
+This command can be put in the documentation
+of a class. It can be used in combination with member grouping
+to avoid that doxygen puts a member group as a subgroup of a
+Public/Protected/Private/... section.
+
+<hr>
\subsection cmdoverload \overload [(function declaration)]
\addindex \overload
diff --git a/doc/faq.doc b/doc/faq.doc
index ecc8ef4..8e3bc1b 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -147,11 +147,21 @@ QTime and QIODevice classes.
Another reason is for the nice and bug free utility classes, like QList,
QDict, QString, QArray, QTextStream, QRegExp etc.
+The GUI front-end doxywizard uses Qt for... well... the GUI!
+
<li><b>Can use doxygen on my Java code?</b>
No, at the moment there is no support for Java. I suggest to
use Sun's JavaDoc instead.
+<li><b>How can I exclude all test directories from my directory tree?</b>
+
+Simply put an exclude pattern like this in the configuration file:
+
+\verbatim
+EXCLUDE_PATTERNS = */test/*
+\endverbatim
+
</ol>
\htmlonly
diff --git a/doc/starting.doc b/doc/starting.doc
index cd52250..e3e67e1 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -493,13 +493,16 @@ detailed information about the group.
Nesting of member groups is not allowed.
-If all members of a member group have the same type and protection level
-(for instance all are static public members), then the whole member
-group is displayed as a subgroup of the type/protection level group
-(the group is displayed as a subsection of the "Static Public Members"
-section for instance). If two or more members have different types,
-then the group is put at the same level as the automatically
-generated groups.
+If all members of a member group inside a class have the same type
+and protection level (for instance all are static public members),
+then the whole member group is displayed as a subgroup of
+the type/protection level group (the group is displayed as a
+subsection of the "Static Public Members" section for instance).
+If two or more members have different types, then the group is put
+at the same level as the automatically generated groups.
+If you want to force all member-groups of a class to be at the top level,
+you should put a \ref cmdnosubgrouping "\\nosubgrouping" command inside the
+documentation of the class.
\par Example:
\verbinclude memgrp.cpp