GNOME Bugzilla – Bug 701919
VHDL cross-references fail when unpaired apostrophe present
Last modified: 2013-08-23 15:04:44 UTC
I am trying to use Doxygen on Win XP/7 to provide requirements cross-referencing within my VHDL project, and have found a major bug related to the use of apostrophes (') in the code. Use of a single (unpaired) apostrophe in code or comments anywhere above an aliased xref causes all aliased xrefs below to fail. The Doxywizard log reports warnings for each xref of the form: <unknown>:{line_num}: Warning: Found unknown command '\{alias_id}' Note that paired apostrophes do not cause any problem. Unpaired apostrophes have widespread use in VHDL for signal/array/type attributes, e.g. vector_signal'range, enum_type'left, array_variable'length, etc. A workaround is to add an in-line comment with a second apostrophe, but this is not feasible for the size of my project, so I cannot use Doxygen until this is fixed.
Can you attach a short example. That makes bug fixing easier.
Created attachment 246722 [details] Example VHDL file to demonstrate unpaired apostrophe bug
Created attachment 246723 [details] Doxyfile to accompany VHDL example
Created attachment 246769 [details] [review] patch try this patch
Thanks, only I'm not sure what to do with this. I've only been using Doxygen as an off-the-shelf installable application - does this patch have to be input at the Doxygen application build stage? If so then unfortunately I have no facility to do this.
Is there any way I can try this patch with the Doxywizard runtime application?
Building a doxygen binary on Linux ( with gcc ) is very simple. Check out the current svn trunk 1. svn co https://doxygen.svn.sourceforge.net/svnroot/doxygen/trunk doxygen-svn 2. change to directory doxygen-svn / cd doxygen-svn 3. sh configure 4. make all On Windows it is also quite easy, but you need Microsoft Visual C++ 2008 Express Edition (freeware). (see doxygen documentation) In both cases it takes only 10 minutes.
Thanks. Sorry to be a pain but I'm not sure where to go with this as we have strict access restrictions on our company network (unlikely to be able to use SVN), and I do not have MS Visual C++. Is there any chance of getting a replacement .exe from you or something? The only other option is for me to wait for a formal release I guess.
download and try this windows binary : http://www.file-upload.net/download-7741950/doxygen1.8.4.rar.html
Thanks! That's just what I needed, and the bug appears to be fixed! I have tried using the new binary with a few designs with unpaired apostrophes and have had no repeat of the problem.
Please don't set the bug to resolved yet, otherwise it will not end up in the mainline.
Thanks, I'll include the patch in the next GIT update.
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.8.5. 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.