summaryrefslogtreecommitdiffstats
path: root/doc/starting.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2002-03-24 20:06:51 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2002-03-24 20:06:51 (GMT)
commita633d7976dbe31f1499efa59ae27ce75ff7015d7 (patch)
tree797740a23dd652f609fa100db4f0c862df4692ed /doc/starting.doc
parent40c0613db241b9015265b2b9f3673e0c7869d3c2 (diff)
downloadDoxygen-a633d7976dbe31f1499efa59ae27ce75ff7015d7.zip
Doxygen-a633d7976dbe31f1499efa59ae27ce75ff7015d7.tar.gz
Doxygen-a633d7976dbe31f1499efa59ae27ce75ff7015d7.tar.bz2
Release-1.2.14-20020324
Diffstat (limited to 'doc/starting.doc')
-rw-r--r--doc/starting.doc7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/starting.doc b/doc/starting.doc
index 5729087..6015ffe 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -184,7 +184,12 @@ basically two options:
namespace or file). See section \ref structuralcommands to learn more
about structural commands.
</ol>
-Files can only be documented using the second option.
+Files can only be documented using the second option, since there is
+no way to but a documentation block before a file. Of course, file members
+(functions, variable, typedefs, defines) do not need an explicit
+structural command; just putting a special documentation block in front or
+behind them will do.
+
The text inside a special documentation block is parsed
before it is written to the HTML and/or \f$\mbox{\LaTeX}\f$ output files.