Re: [Doxygen-users] VHDL: how to include elements of a record (and the associated comment)?

[Fontaine, F. <Fil...@nl...>]

Hi Alasdair,



Thanks for the suggestion. Unfortunately, adding the '<' character doesn't help. This character just gets included as text in the documentation....



Filip



________________________________
Van: Ferro, Alasdair [Ala...@me...]
Verzonden: donderdag 23 april 2015 11:51
Aan: Fontaine, Filip; dox...@li...
Onderwerp: RE: [Doxygen-users] VHDL: how to include elements of a record (and the associated comment)?

Filip,

I think that you need to use --!< to document after the member. Have a look at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#memberdoc

For example:

   --! description for a type, which actually is a record
   type my_record_1 is record
      element_11 : std_logic;     --!< comment for first element of my_record_1
      element_12 : std_logic;     --!< comment for second element of my_record_1
   end record;


Alasdair