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 665506 - option to de-uglify names
option to de-uglify names
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: general
1.7.4
Other Linux
: Normal enhancement
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
Depends on:
Blocks:
 
 
Reported: 2011-12-03 17:18 UTC by Jonathan Wakely
Modified: 2018-07-30 09:58 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Jonathan Wakely 2011-12-03 17:18:02 UTC
The GNU C++ standard library, libstdc++, uses doxygen to generate our API docs:
http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/

In order to prevent clashes with user-defined macros, standard library code must be "uglified" to use names reserved for the implementation i.e. you must use '__var' not 'var'

That uglification is an implementation detail, not part of the API.  It would greatly improve our docs if there could be a doxygen option to "de-uglify" names in the output.

So given:

    /** @param  t  The object to frob.
     */
    template<typename _Tp>
      _Tp frobnicate(_Tp __t);

I'd like the doxygen output to show the function as:

    template<typename Tp>
      Tp func(Tp t);

And also to recognise that the @param t relates to the parameter __t (rather than warning about undocumented parameters).

The alteration should only be done for function parameters and template parameters.  Functions, types and namespaces should not be altered.

Would something like this be possible?  If it would be relatively easy for someone unfamiliar with the Doxygen code to implement I could try to do so myself.
Comment 1 André Klapper 2018-07-30 09:58:11 UTC
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to 

   https://github.com/doxygen/doxygen/issues

All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github.

Hence I am closing this GNOME Bugzilla ticket.
Please use the corresponding ticket in Github instead. Thanks a lot!