« Return to Thread: \property for vhdl

Re: \property for vhdl

by Wallner, Lorenz :: Rate this Message:

Hi all,

After getting help from mkk i settled on the following header for my vhdl-files with the architectures:

--! 
--! 
--! \class TFL_BLAH_e::TFL_BLAH_a
--! \brief Brief description of the architecture

--! \par Filename
--!                 TFL_BLAH_a.vhd
--! \par Copyright
--!                   (c) Siemens AG, Automation Systems
--!
--! \par Version
--!                   see TFL_BLAH_p package
--!
--! \par History
--!                   see TFL_BLAH_p package
--!
--! \par Authors
--!                    Max Mustermann

--! Detailed description of the architecture.

I used the following tricks:

- To associate a comment block with a architecture sitting somewhere else in the code, use the command

\class entity::architecture

- I wanted to have some kind of visual divider in the sourcecode, which should not appear in the html-documentation. Since the trick with the line of *'s like in C-code didn't seem to work, i inserted the html-comment --!

- I know that i could have used \authors instead of \par authors, but i wanted it to keep homogenous with the other fields (copyright etc. <- and i was to lazy to define custom commands for those...)

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

« Return to Thread: \property for vhdl