After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 566921 - \c combined with % in a \param ignores the :: operator
\c combined with % in a \param ignores the :: operator
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.5.7.1
Other All
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2009-01-07 16:54 UTC by Moshe Kruger
Modified: 2011-03-28 14:18 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Moshe Kruger 2009-01-07 16:54:28 UTC
Please describe the problem:
When using the following combination:

\param nDataAttributeRefs Number of \c %IBO::DataAttributeRef objects

The output in HTML is:
Returns the number of IBODataAttributeRef objects that fit constraints.  

and no link for IBO::DataAttributeRef is created.

When I write:

\param nDataAttributeRefs Number of \c IBO::DataAttributeRef objects

The output in HTML is:
Returns the number of IBO::DataAttributeRef objects that fit constraints.  

and the link for IBO::DataAttributeRef is created.

So, I cannot use the % feature here.



Steps to reproduce:
1. 
2. 
3. 


Actual results:


Expected results:


Does this happen every time?
Yes

Other information:
Comment 1 Dimitri van Heesch 2009-01-28 20:19:41 UTC
I do not understand the problem you have.

% is used to prevent a automatic link (as discussed here: http://www.stack.nl/~dimitri/doxygen/autolink.html)

From your description it seems to work as advertised, so please clarify.

Comment 2 Moshe Kruger 2009-04-29 07:56:37 UTC
Using the example:

\param nDataAttributeRefs Number of \c %IBO::DataAttributeRef objects

The output in HTML is:
Returns the number of IBODataAttributeRef objects that fit constraints.

*****************
The point is this: when combining \c and %, doxygen concatenates IBO and DataAttributeRef and renders it: IBODataAttributeRef. The affect is that no link is created to the member IBO::DataAttributeRef.

Comment 3 Moshe Kruger 2009-05-27 13:37:24 UTC
(In reply to comment #2)
> Using the example:
> \param nDataAttributeRefs Number of \c %IBO::DataAttributeRef objects
> The output in HTML is:
> Returns the number of IBODataAttributeRef objects that fit constraints.
> *****************
> The point is this: when combining \c and %, doxygen concatenates IBO and
> DataAttributeRef and renders it: IBODataAttributeRef. The affect is that no
> link is created to the member IBO::DataAttributeRef.

In looking at the problem again, I realize it has nothing to do with the \c. The problem is using %.
Comment 4 Moshe Kruger 2011-01-31 09:21:15 UTC
(In reply to comment #1)
> I do not understand the problem you have.
> % is used to prevent a automatic link (as discussed here:
> http://www.stack.nl/~dimitri/doxygen/autolink.html)
> From your description it seems to work as advertised, so please clarify.

This bug has still not been fixed.
-------------
Dimitri, you wrote me in a private email (5/27/2009):

It is a bug indeed (the removal of the ::).
A simple workaround, use %IBO::%DataAttributeRef
-------------
There are still instances where programmers in our company are using the fault format. The difference is that in the version of Doxygen we are using now, this is caught by the compiler and reported with the messsage:

Generating /users/gdadmin/PG41/project/src/library/BizData/TAttribute.h:84: warning: explicit link request to 'DataAttributeRef' could not be resolved.

Still, the format %IBO::DataAttributeRef is not being handled and produces the warning and the resulting documentation reads thus:

BBODataAttribute

which is unintelligible and useless.
Comment 5 Dimitri van Heesch 2011-02-05 15:33:33 UTC
Confirmed. Should be fixed in the next subversion update.
Comment 6 Dimitri van Heesch 2011-03-28 14:18:47 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.4. 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.