GNOME Bugzilla – Bug 778525
VHDL: Functions with documentation are rendered wrongly in the RTF output
Last modified: 2018-07-30 10:01:04 UTC
Created attachment 345567 [details] example demonstrating the problem For a package with two functions, the documentation for the first function is shown as a second bullet, where the next function is shown after the documentation of the first function and on the same line. The documentation for the second function is show outside of the bullet lists. i.e. Functions • std_logic_vector CRC8_D1 ( Data: in std_logic , CRC: in std_logic_vector( 7 downto 0) ) • D1. std_logic_vector CRC8_D8 ( Data: in std_logic_vector( 7 downto 0) , CRC: in std_logic_vector( 7 downto 0) ) Docs for WRONG. Expected two bullets, one for each function, where the documentation is shown as part of the function.
--! D1 function CRC8_D1 ( Data: std_logic; CRC: std_logic_vector(7 downto 0)) return std_logic_vector is variable WRONG: std_logic; --! Docs for WRONG variable documention inside function etc. is not supported.
We have here 2 problems: - mangling of the output, for the I've just pushed a proposed patch to github (pull request 746, https://github.com/doxygen/doxygen/pull/746). Related bug 782754 - problem with the unsupported variable documention inside function etc., this is not fixed
Code has been integrated in master on github.
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to https://github.com/doxygen/doxygen/issues All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github. Hence I am closing this GNOME Bugzilla ticket. Please use the corresponding ticket in Github instead. Thanks a lot!