summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/docblocks.doc3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index 9d14f6e..a427b76 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -513,6 +513,9 @@ Here is an example VHDL file with doxygen comments:
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
+As of VHDL 2008 it is also to use `/‍*` type comments. Doxygen will handle `/‍* ... *‍/`
+as plain comments and `/‍*! ... *‍/` comments as special doxygen comments with documentaton.
+
To get proper looking output you need to set
\ref cfg_optimize_output_vhdl "OPTIMIZE_OUTPUT_VHDL" to \c YES in the
configuration file. This will also affect a number of other settings. When they