Hi,
I want to use
doxygen for documentation of my vhdl code.
Typically my
existing source-files have the following structure:
-- Header with list
of authors, brief description of the file etc.
-- Header with list
of authors, brief description of the file etc.
-- Header with list
of authors, brief description of the file etc.
-- Header with list
of authors, brief description of the file etc.
-- Header with list
of authors, brief description of the file etc.
--A more detailed
description of the file,
-- which is actually
the detailed description of
-- the entity or
architecture included in the
--
file
--Some standard
includes
LIBRARY ieee;
USE
ieee.std_logic_1164.all;
USE ieee.numeric_std.all;
ENTITY BLAH is
-- Now follows the actual code
I would like to keep
this layout, because this way i have all the important information at the top of
the source file, typicall a text editor will display the top part with this
information first when a new file is opened.
The problem is that
i cannot associate the brief and detailed description from the first two comment
blocks with the entity definition. If i just use the doxygen-style comments, the
comments will be associated with the "LIBRARY
ieee;" instruction. If i put a \file in the top comment, the description
will be associated with the file.
What i need is the
equivalent of the \fn command for vhdl-entities and architectures. Is something
like that possible?
I have already tried
the \property command like this:
--! @property BLAH
or
--! @property ENTITY
BLAH
but it did not
work.
The other option
would be to move the comments with the description directly above the entity
declaration, but as i already said, i want all the info to be at the very top of
the file.
Another possibility
would be to exclude the includes from doxygen-processing with the \cond and
\endcond commands, but of course then the used packages etc. will not appear in
the produced documentation.
With best
regards,
Lorenz Wallner
Siemens AG
Industry
Sector
Industry Automation Division
Industrial Automation
Systems
Research & Development
I IA AS R&D DH FTH 1
Siemensstr. 2-4
90766 Fuerth, Germany
Tel.: +49 (911) 978-2233
Fax: +49 (911) 978-3155
lorenz.wallner@...
Siemens Aktiengesellschaft:
Chairman of the Supervisory Board: Gerhard Cromme; Managing Board: Peter
Loescher, Chairman, President and Chief Executive Officer; Wolfgang Dehen,
Brigitte Ederer, Joe Kaeser, Barbara Kux, Hermann Requardt, Siegfried Russwurm,
Peter Y. Solmssen; Registered offices: Berlin and Munich, Germany; Commercial
registries: Berlin Charlottenburg, HRB 12300, Munich, HRB 6684; WEEE-Reg.-No. DE
23691322
------------------------------------------------------------------------------
Protect Your Site and Customers from Malware Attacks
Learn about various malware tactics and how to avoid them. Understand
malware threats, the impact they can have on your business, and how you
can protect your company and customers by using code signing.
http://p.sf.net/sfu/oracle-sfdevnl_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users
