Skip to content

Commit

Permalink
issue #7436 Incorrect handling of block comments in VHDL
Browse files Browse the repository at this point in the history
Added some documentation
  • Loading branch information
albert-github committed Dec 11, 2019
1 parent 1a5bbad commit ac303e2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/docblocks.doc
Expand Up @@ -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
Expand Down

0 comments on commit ac303e2

Please sign in to comment.