doxygen-users

[Doxygen-users] VHDL Support

[Paul J. <joi...@fn...>]

Hello all,

 

At the bottom of the online manual section on Documenting the Code
(http://www.stack.nl/~dimitri/doxygen/docblocks.html)  there is a section
describing documentation blocks in VHDL and a special configuration
parameter OPTIMIZE_OUTPUT_VHDL.       Is this available in version 1.5.4?
The tarball I download from the website and compile does not seem to support
this feature and a 'doxygen -g' command generates a Doxyfile which does not
have the OPTIMIZE_OUTPUT_VHDL setting.   Is this supported in a later
revision of 1.5.4?  

 

Paul

 

Paul W. Joireman 

Fermi National Accelerator Lab

Batavia, IL 60510

joi...@fn...


---------------------------------------------------------------- 
"An expert is a man who has made all the mistakes which can be made, in a
narrow field." 
-- Niels Bohr 1885-1962

 

[Doxygen-users] VHDL Support

[Jaco N. <nau...@gm...>]

Hi Guys

I'm new on this list so if this is an old question apologies.

We are documenting VHDL code using doxygen and everything is fine,
except we are using HDL Author for graphical components and it
automatically generates the output files for these graphical
components. We've managed to get the output to this point:

-- -- DESCRIPTION
-- -- ===========
-- --! @brief Add a brief description of your architecture.
-- --!
-- --! @details This must be a detailed description of your architecture. Note
-- --! that the description can be multiple lines and can have
multiple paragraphs
-- --! by adding a single open line like the one below.
-- --!
-- --! This is the second paragraph of the detailed description.
-- --!
-- --! REVISION LIST<br>
-- --! =============
-- --!
-- --! 1.00   20YY/MM/DD   Author Name: New Version<br>
-- --! 1.01   YYYY/MM/DD   Author Name: Add a brief synopsis of the changes made
entity BLOCK_TEMPLATE is

However doxygen can't parse it because HDL Author adds the -- before the --!.

Is there any way to tell doxygen to still parse these lines?

Thank you,
Jaco

Re: [Doxygen-users] VHDL Support

[Paul J. <joi...@fn...>]

Never mind.   I got it working with the latest SVN release.   Sorry for the
chatter.

 

--Paul J.

 

 

From: dox...@li...
[mailto:dox...@li...] On Behalf Of Paul
Joireman
Sent: Monday, January 28, 2008 1:42 PM
To: 'Doxygen users mailinglist'
Subject: [Doxygen-users] VHDL Support

 

Hello all,

 

At the bottom of the online manual section on Documenting the Code
(http://www.stack.nl/~dimitri/doxygen/docblocks.html)  there is a section
describing documentation blocks in VHDL and a special configuration
parameter OPTIMIZE_OUTPUT_VHDL.       Is this available in version 1.5.4?
The tarball I download from the website and compile does not seem to support
this feature and a 'doxygen -g' command generates a Doxyfile which does not
have the OPTIMIZE_OUTPUT_VHDL setting.   Is this supported in a later
revision of 1.5.4?  

 

Paul

 

Paul W. Joireman 

Fermi National Accelerator Lab

Batavia, IL 60510

joi...@fn...


---------------------------------------------------------------- 
"An expert is a man who has made all the mistakes which can be made, in a
narrow field." 
-- Niels Bohr 1885-1962