Re: \property for vhdl

Jaco Naude wrote:

Hi

Thanks for the inputs. I've tried that but it does not seem to work. This is
what I've done:

00016 -- -- DESCRIPTION
00017 -- -- ===========   00018 -- --! \class comp_stc_freq_ctrl 00019
-- --! \brief Testing class and brief with an entity.
                                         00020 -- --! Second line of
test00021 -- --! GENERICS<br>00022 -- --! =============00023 --
--!00024 -- --! G_RESET_ACTIVE: The reset active generic
controls the polarity of00025 -- --! the reset inside this
block.<br>00026 -- --!00027 -- --! REVISION LIST<br>00028 -- --!
=============00029 -- --!00030 -- --! 1.00   2010/10/05   JP Naude:
New Version<br>


The output however does not show any of my test comments. Also this way of
doing has the effect that some ports that exists in the parent entity are
described as being "Reimplemented" which is not the case in VHDL.

CLK <classcomp__stc__freq__ctrl.html#acb2efc025a323c15f28a319e894909d0> *in
**std_logic *[Port]

Reimplemented from
mem_manager_stc<classmem__manager__stc.html#acb2efc025a323c15f28a319e894909d0>
.

Definition at line 41<comp__stc__freq__ctrl__entity_8vhd_source.html#l00041> of
file comp_stc_freq_ctrl_entity.vhd<comp__stc__freq__ctrl__entity_8vhd_source.html>
.


If I'm doing something wrong please let me know. Otherwise is there any
other way of doing this?

Is there any plans to extend VHDL support in doxygen?

Thanks,
Jaco


On Thu, Jan 13, 2011 at 5:56 PM, mkk1 <mkreis@gmx.net> wrote:

>
> Hi,
>
> --! \class my_pkg
> --! \brief Package ...
>
> --! \details Package ...
> --! This text should  appear on the my_pkg page(Detailed Description).
>
> --! @brief ieee
> library ieee;
>
> package my_pkg is
>
>  constant apa : integer := 3;   --! Monkey
> end;
>
> try the \class command with the name of the entity/package
>
>
> Wallner, Lorenz wrote:
> >
> > 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
> > mailto:lorenz.wallner@siemens.com
> >
> > 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@lists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
> >
>
> --
> View this message in context:
> http://old.nabble.com/%5Cproperty-for-vhdl-tp30662705p30664696.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
>
>
> ------------------------------------------------------------------------------
> 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@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

------------------------------------------------------------------------------
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@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users