GNOME Bugzilla – Bug 652086
does ALIAS work for VHDL code?
Last modified: 2017-12-25 18:43:55 UTC
I have specified an alias in the Doxyfile as follows: ALIASES += register_definition{3}="\1 booh \2" then I put comment into the VHDL comment block: --! @register_definition{0x680014}{32}{Turn Clock Watchdog} and now, during compilation I get: /home/belohrad/SVN/fbctdab/branches/06_improving_bpf/stratix_fbct/sources/newstyle/tdclk_watchdog/tdclk_watchdog.vhd:103: warning: Found unknown command `\register_definition' and of course HTML does not contain the aliased code. Does the ALIAS work for VHDL code?
I tried the alias example from the manual ALIASES += Bold{1}="<b>\1</b>" --! signal \Bold{main clk} clk : in STD_LOGIC; and it works. try version 1.7.4
As far as I can see the usage of the ALIAS is not conform the documentation and should be like: @register_definition{0x680014,32,Turn Clock Watchdog} The remark of mk is just for an ALIAS with a single argument. I checked it with version 1.8.5. I think this problem can be set to: resolved, notabug
In version 1.8.6 and further it does not work anymore! : warning: Found unknown command `\register_definition' Obviously there's a change in that version!
1) it does make sense a lot of sense to add a comment to a closed issue as in most cases this people will filter the issues and not display resolved issues. So either create an new issue or reopen the current issue but in both cases: attach a (small) self-contained example (source+config file in a tar or zip) that allows us to reproduce the problem? and also indicate the results with the latest version (1.8.13) of doxygen.
Created attachment 352921 [details] ALIAS with VHDL code in Doxygen 1.8.5/1.8.6 and 1.8.13 I've made a simple testcase with a counter (VHDL code): In Doxygen version 1.8.5 the ALIAS works, but in further versions it does not word ("unknown command"). Just look at the HTML output of each Doxygen version.
try register_definition{2}="\1 booh \2" change @reg{Counter register,Down counter with n bits} in @register_definition{Counter register,Down counter with n bits} in your example
Created attachment 352980 [details] Updated example: ALIAS with VHDL code in Doxygen 1.8.5/1.8.6 and 1.8.13 Thanks, but the phrase "reg" or "register_definition" isn't the critical issue. It's rather the processing of the ALIAS which seems to be "skipped" in version 1.8.6 and above. I've updated my example to match the previous example and show that it is a bug.
I've just pushed a proposed patch to github (pull request 571)
For my application and testcase your patch works! Thanks a lot!
Code integrated in master version on github.
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.8.14. Please verify if this is indeed the case. Reopen the bug if you think it is not fixed and please include any additional information that you think can be relevant (preferably in the form of a self-contained example).