Carsten Jørgensen-2 wrote:
>
> Hi all
>
> I am using doxygen to generate documentation for a VHDL project.
>
> Most things seems to work fine however for types (or packages?) there
> is a rather cumbersome problem. The following is an example:
>
> --! First line is ok.
> --!
> --! This description will be the second line under "Detailed
> Description" in the generated HTML, also ok.
> --! Also ok here...
> package example_package is
>
> --! This is correctly inserted under Member Data Documentation
> constant SOME_CONSTANT : integer := 42;
>
> --! This line is correctly included under Member Data Documentation
> constant SOME_OTHER_CONSTANT : integer := 42;
>
> --! A type definition. This line is not included in the generated HTML
> under
> --! Types but is it is included under Member Data Documentation.
> type some_type is
> record
> --! This line is not shown at all!!!
> some_signal : std_ulogic_vector(5 downto 0);
>
> --! This line is not shown at all!!!
> some_other_signal : std_ulogic;
> end record;
> end package example_package;
>
>
> Is there any way I can include the documentation for some_signal and
> some_other_signal? I have tried the latest version as well as 1.7.6.
> With at least 1.7.6 I was able to generate documentation for the two
> signals but unfortunately it was mixed in with the type documentation
> (and all other signal documentations in that type) so it was
> completely unreadable.
>
> Best regards carsten
>
> ------------------------------------------------------------------------------
> Keep yourself connected to Go Parallel:
> DESIGN Expert tips on starting your parallel project right.
> http://goparallel.sourceforge.net/
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
command \brief is missing
1) try
--! \brief A type definition. This line is not included in the generated
HTML under
--! Types but is it is included under Member Data Documentation.
--! \param some_signal This line will shown
--! \param some_other_signal This line will shown
type some_type is record
some_signal : std_ulogic_vector(5 downto 0);
some_other_signal : std_ulogic;
end record;
----------------------------------------------------------------
2)
type some_type is record
--! \param some_signal This line will shown
--! \param some_other_signal This line will shown
--! \code record
some_signal : std_ulogic_vector(5 downto 0);
some_other_signal : std_ulogic;
--! \endcode
end record;
tried with doxygen version 1.8.2-20120930
--
View this message in context:
http://old.nabble.com/VHDL-and-packages-tp34747626p34748415.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.
------------------------------------------------------------------------------
Keep yourself connected to Go Parallel:
DESIGN Expert tips on starting your parallel project right.
http://goparallel.sourceforge.net/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
