Last modified: 2014-03-14 13:02:17 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T43721, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 41721 - Create method anchors for Doxygen that are suitable for permalinks
Create method anchors for Doxygen that are suitable for permalinks
Status: RESOLVED WONTFIX
Product: Wikimedia
Classification: Unclassified
General/Unknown (Other open bugs)
unspecified
All All
: Lowest enhancement (vote)
: ---
Assigned To: Nobody - You can work on this!
aklapper-moreinfo
: upstream
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2012-11-03 02:47 UTC by Nathan Larson
Modified: 2014-03-14 13:02 UTC (History)
1 user (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Nathan Larson 2012-11-03 02:47:30 UTC
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.
Comment 1 Andre Klapper 2013-02-26 20:35:04 UTC
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?
Comment 2 Andre Klapper 2014-03-14 11:46:56 UTC
Closing - no reply to comment 1.
Comment 3 Nathan Larson 2014-03-14 13:02:17 UTC
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.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links