summaryrefslogtreecommitdiffstats
path: root/doc/docblocks.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2005-09-18 19:25:32 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2005-09-18 19:25:32 (GMT)
commitdb36de70fc9090e26c22ab288492407becb3a95e (patch)
treeb25e22f178d0e6d1ebb7e74f2348e9811a2f5394 /doc/docblocks.doc
parent3b98221d43ba62088538ead3aa726f81dd9202f9 (diff)
downloadDoxygen-db36de70fc9090e26c22ab288492407becb3a95e.zip
Doxygen-db36de70fc9090e26c22ab288492407becb3a95e.tar.gz
Doxygen-db36de70fc9090e26c22ab288492407becb3a95e.tar.bz2
Release-1.4.4-20050918
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r--doc/docblocks.doc10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index a0132d8..de1e94d 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -276,20 +276,22 @@ Here is an example of the use of these comment blocks:
\section structuralcommands Documentation at other places
-So far we have assumed that the documentation blocks are always located in
-front of the declaration or definition of a file, class or namespace or in
+So far we have assumed that the documentation blocks are always located \e in
+\e front of the declaration or definition of a file, class or namespace or in
front or after one of its members.
Although this is often comfortable, there may sometimes be reasons to put the
documentation somewhere else. For documenting a file this is even
required since there is no such thing as "in front of a file".
+
Doxygen allows you to put your documentation blocks practically
anywhere (the exception is inside the body of a function or inside a
normal C style comment block).
The price you pay for not putting the
-documentation block before (or after) an item is the need to put a
+documentation block directly before (or after) an item is the need to put a
structural command inside the documentation block, which leads to some
-duplication of information.
+duplication of information. So in practice you should \e avoid the use of
+structural commands \e unless other requirements force you to do so.
Structural commands (like all other commands) start with a backslash
(<tt>\\</tt>), or an at-sign (<tt>\@</tt>) if you prefer JavaDoc style,