diff options
| author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2001-06-10 14:32:16 (GMT) |
|---|---|---|
| committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2001-06-10 14:32:16 (GMT) |
| commit | 6bcfa2ef74dee5be64110aa0b06b368d498c9a73 (patch) | |
| tree | e7d24c06a9c225fe4a29004a178cc28a435cdc67 /doc/docblocks.doc | |
| parent | c2107e15c87bc0b964d333e24ec193c1a2d27335 (diff) | |
| download | Doxygen-6bcfa2ef74dee5be64110aa0b06b368d498c9a73.zip Doxygen-6bcfa2ef74dee5be64110aa0b06b368d498c9a73.tar.gz Doxygen-6bcfa2ef74dee5be64110aa0b06b368d498c9a73.tar.bz2 | |
Release-1.2.8.1
Diffstat (limited to 'doc/docblocks.doc')
| -rw-r--r-- | doc/docblocks.doc | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index bb73ccb..611f0ee 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -180,16 +180,19 @@ additional comment blocks: \verbatim /*!< ... */ \endverbatim -This block can be used to put a Qt style documentation blocks after a member. -The one line version look as follows: +This block can be used to put a Qt style detailed +documentation block after a member. +The one line brief description looks as follows: \verbatim //!< ... \endverbatim -There are also JavaDoc versions: +There are also JavaDoc versions for detailed documentation: \verbatim /**< ... */ \endverbatim -and +(where the first sentence is the brief description +if \c JAVADOC_AUTOBRIEF is set to \c YES) +and there is a separate brief description as well: \verbatim ///< ... \endverbatim |