summaryrefslogtreecommitdiffstats
path: root/doc/docblocks.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2013-04-02 19:27:49 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2013-04-02 19:27:49 (GMT)
commitebf4b3641c9149eaf4468aa8df64e1c7517e5f0c (patch)
tree23804fcf753b3487b9a1ea28d4d28b71fa4ae208 /doc/docblocks.doc
parentdeaa34e0c1d990f37fe00e465ac7a22f705904f0 (diff)
downloadDoxygen-ebf4b3641c9149eaf4468aa8df64e1c7517e5f0c.zip
Doxygen-ebf4b3641c9149eaf4468aa8df64e1c7517e5f0c.tar.gz
Doxygen-ebf4b3641c9149eaf4468aa8df64e1c7517e5f0c.tar.bz2
Release-1.8.3.1-20130402
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r--doc/docblocks.doc4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index 0363e7e..1b96361 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -433,8 +433,8 @@ config file.
For VHDL a comment normally start with "--". Doxygen will extract comments
starting with "--!". There are only two types of comment blocks in VHDL;
-a one line --! comment representing a brief description, and a multi-line
---! comment (where the --! prefix is repeated for each line) representing
+a one line "--!" comment representing a brief description, and a multi-line
+"--!" comment (where the "--!" prefix is repeated for each line) representing
a detailed description.
Comments are always located in front of the item that is being documented