diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2012-02-20 21:09:54 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2012-02-20 21:09:54 (GMT) |
commit | 709a80a791105768cbf8e9d58fdc811c23e071f0 (patch) | |
tree | a9a7b7b5542fbc9a2189f8ae6b39379770043b48 /doc/docblocks.doc | |
parent | 9b81ead283ea3f56a89835ac8afcdb75cdaadd03 (diff) | |
download | Doxygen-709a80a791105768cbf8e9d58fdc811c23e071f0.zip Doxygen-709a80a791105768cbf8e9d58fdc811c23e071f0.tar.gz Doxygen-709a80a791105768cbf8e9d58fdc811c23e071f0.tar.bz2 |
Release-1.7.6.1-20120220
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r-- | doc/docblocks.doc | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 093122b..facd1b5 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -15,6 +15,7 @@ * */ /*! \page docblocks Documenting the code +\tableofcontents This chapter covers two topics: 1. How to put comments in your code such that doxygen incorporates them in @@ -504,7 +505,7 @@ lower then sign). The brief documentation also ends at a line not starting with a \c # (hash sign). Inside doxygen comment blocks all normal doxygen markings are supported. -The only expections are described in the following two paragraphs. +The only exceptions are described in the following two paragraphs. If a doxygen comment block ends with a line containing only \c #\\code or \c #\@code all code until a line only containing \c #\\endcode @@ -560,7 +561,7 @@ Go to the <a href="lists.html">next</a> section or return to the \section docstructure Anatomy of a comment block -The previous section focussed on how to make the comments in your code known +The previous section focused on how to make the comments in your code known to doxygen, it explained the difference between a brief and a detailed description, and the use of structural commands. |