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

Autolinking occurs for lowercase names (Origin: bugzilla #594787) #3513

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.6.1-SVN on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2009-09-10 19:14:07 +0000, Trevor Robinson wrote:

Created attachment 142933
Patch to uncomment lowercase exclusion for autolinking

The autolinking documentation says that a class name must contain at least one
uppercase character to be linked, but this doesn't seem to be true. For
instance, I have a class template called "null", and every occurrence of the
word "null" in my documentation is (undesirably) autolinking to it.

I know that as a workaround I could prefix each unwanted occurrence with "%",
but that seems impractical. I have other classes, namespaces, and templates
with common names, such as "function", "date", etc., that often shouldn't
autolink either.

I found an unresolved post in the mail archive from Dec 2007 on this issue,
which contains a small example and a link to the output:

http://sourceforge.net/mailarchive/message.php?msg_id=20071224131931.GA25868@elmex

I'm guessing the change occurred in revision 571 from Jan 2007
(Release-1.5.1-20070107), when the following code was commented out in
resolveRef in util.cpp at current line number 4138:

//if (!inSeeBlock && scopePos==-1 && isLowerCase(tsName))
//{ // link to lower case only name => do not try to autolink 
//  return FALSE;
//}

Uncommenting these lines and isLowerCase() restores behavior similar to what is
documented. Actually, the documentation should say "contain at least one
non-lower case character", rather than "contain at least one upper case
character", because numbers and underscores will also enable autolinking.

Scanning the release notes for 1.5.2, I don't see any mention of this change,
so maybe it was accidental.

On 2009-10-10 14:42:59 +0000, Dimitri van Heesch wrote:

*** Bug 597580 has been marked as a duplicate of this bug. ***

On 2009-10-10 14:52:07 +0000, Dimitri van Heesch wrote:

I will restore the pre 1.5.2 behaviour as suggested, and fix the documentation.

On 2009-12-30 13:39:02 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.6.2. Please verify if this is indeed the case and reopen the
bug if you think it is not fixed (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