Page MenuHomePhabricator

Create method anchors for Doxygen that are suitable for permalinks
Closed, DeclinedPublic

Description

Presently, if you want to link to the documentation for, say, ApiBase::dieUsage(), you have to use a hash-anchored url like https://svn.wikimedia.org/doc/classApiBase.html#a3bbd2e864a2dec0dd468f6e35db8cb8a . As the documentation changes, that anchor will no longer go to the desired method. It would be useful to have a more permanent way of linking to a method -- one that won't break unless the method is actually removed from the class or renamed.


Version: unspecified
Severity: enhancement
Whiteboard: aklapper-moreinfo

Details

Reference
bz41721

Event Timeline

bzimport raised the priority of this task from to Lowest.Nov 22 2014, 1:08 AM
bzimport set Reference to bz41721.
bzimport added a subscriber: Unknown Object (MLST).

Nathan:
According to https://bugzilla.gnome.org/show_bug.cgi?id=463075#c2 "the anchors are stable, i.e. as long as you do not change the prototype of a member the anchor will be the same (e.g. you can add other members to the class)."

To me this looks like a WONTFIX/INVALID request - do you agree, or do I miss some important arguments?

Closing - no reply to comment 1.

Oops, didn't notice that earlier comment till now. Some prototypes (e.g. DatabaseBase::select()) must have changed several times, because the links had to be updated. I guess a workaround, in the case of an anchor that a bunch of different wiki pages point to, would be to create a template pointing to that anchor and transclude it. Then the template could be updated as needed. A bot could do that work, perhaps, by parsing the documentation.

It might be kinda cool too to have a "what links here" for various functions, and see what wiki pages reference them. Templates could also implement that, perhaps.