New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VHDL cross-references fail when unpaired apostrophe present (Origin: bugzilla #701919) #5205

doxygen opened this Issue Jul 2, 2018 · 0 comments


None yet
1 participant

doxygen commented Jul 2, 2018

status RESOLVED severity major in component build for ---
Reported in version 1.8.4 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2013-06-10 09:33:16 +0000, adbeavis wrote:

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.

On 2013-06-11 19:33:07 +0000, mk wrote:

Can you attach a short example.
That makes bug fixing easier.

On 2013-06-13 14:11:03 +0000, adbeavis wrote:

Created attachment 246722
Example VHDL file to demonstrate unpaired apostrophe bug

On 2013-06-13 14:11:42 +0000, adbeavis wrote:

Created attachment 246723
Doxyfile to accompany VHDL example

On 2013-06-13 20:43:28 +0000, mk wrote:

Created attachment 246769

try this patch

On 2013-06-14 07:41:33 +0000, adbeavis wrote:

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.

On 2013-06-18 07:09:38 +0000, adbeavis wrote:

Is there any way I can try this patch with the Doxywizard runtime application?

On 2013-06-18 16:33:45 +0000, mk wrote:

Building a doxygen binary on Linux ( with gcc ) is very simple.
Check out the current svn trunk

  1. svn co 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.

On 2013-06-21 10:55:33 +0000, adbeavis wrote:

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.

On 2013-06-21 19:01:25 +0000, mk wrote:

download and try this windows binary :

On 2013-06-25 10:23:56 +0000, adbeavis wrote:

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.

On 2013-07-14 17:31:35 +0000, Dimitri van Heesch wrote:

Please don't set the bug to resolved yet, otherwise it will not end up in the mainline.

On 2013-08-04 11:43:02 +0000, Dimitri van Heesch wrote:

Thanks, I'll include the patch in the next GIT update.

On 2013-08-23 15:04:44 +0000, Dimitri van Heesch wrote:

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.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment