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 342107 - Online docs for "Automatic link generation" incorrect for overloaded functions
Online docs for "Automatic link generation" incorrect for overloaded functions
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: documentation
1.4.x
Other All
: Normal minor
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
: 356597 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2006-05-17 11:04 UTC by Feuersaenger
Modified: 2006-10-19 19:21 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Feuersaenger 2006-05-17 11:04:13 UTC
Documentation 
Section: http://www.stack.nl/~dimitri/doxygen/autolink.html
- "Note 1: The patterns above should not contain spaces, tabs or newlines."
Example:
a documented member
void aMemberFunction( const std::string& a, bool b );

can be referenced with spaces, i.e.
@see aMemberFunction(const std::string&,bool)

- it does not mention that 'const' modifiers to member functions are required.
Example:
a documented member
void aMemberFunction( const std::string& a, bool b ) const;

requires the 'const',
@see aMemberFunction(const std::string&,bool) const



Correct version:
Maybe
Note 1: Function argument should be specified with correct types, i.e. 
'fun(const std::string&,bool)'.

Note 2: Member function modifiers (like 'const') are required to identify the
target, i.e.
'fun(int) const'

Other information:
Thank's for the cool program! A fix to the documentation will save debugging
time. Maybe additional warnings for possibly broken links would be helpful, too.
Comment 1 Dimitri van Heesch 2006-09-18 20:19:47 UTC
I'll adjust the documentation to make this more clear.
Comment 2 Dimitri van Heesch 2006-09-18 20:22:27 UTC
*** Bug 356597 has been marked as a duplicate of this bug. ***
Comment 3 Dimitri van Heesch 2006-10-19 19:21:18 UTC
This bug was marked "assigned" by me some time ago, which means it should be fixed in version 1.5.0 and is hereby marked as such. I would kindly request you to check if this version indeed fixes the problem and reopen the bug report should you still see the same problem.