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

\c combined with % in a \param ignores the :: operator (Origin: bugzilla #566921) #3217

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.5.7.1 on platform Other
Assigned to: Dimitri van Heesch

On 2009-01-07 16:54:28 +0000, Moshe Kruger wrote:

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:

On 2009-01-28 20:19:41 +0000, Dimitri van Heesch wrote:

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.

On 2009-04-29 07:56:37 +0000, Moshe Kruger wrote:

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.

On 2009-05-27 13:37:24 +0000, Moshe Kruger wrote:

(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 %.

On 2011-01-31 09:21:15 +0000, Moshe Kruger wrote:

(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.

On 2011-02-05 15:33:33 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2011-03-28 14:18:47 +0000, Dimitri van Heesch wrote:

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.

@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