Last modified: 2011-09-19 19:21:51 UTC

Wikimedia Bugzilla is closed!

Wikimedia has migrated from Bugzilla to Phabricator. Bug reports should be created and updated in Wikimedia Phabricator instead. Please create an account in Phabricator and add your Bugzilla email address to it.
Wikimedia Bugzilla is read-only. If you try to edit or create any bug report in Bugzilla you will be shown an intentional error message.
In order to access the Phabricator task corresponding to a Bugzilla report, just remove "static-" from its URL.
You could still run searches in Bugzilla or access your list of votes but bug reports will obviously not be up-to-date in Bugzilla.
Bug 31005 - Functions / Properties should go into our doxygen docs + undoc'ed added
Functions / Properties should go into our doxygen docs + undoc'ed added
Status: RESOLVED WORKSFORME
Product: MediaWiki
Classification: Unclassified
Documentation (Other open bugs)
unspecified
All All
: Unprioritized major (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks: documentation
  Show dependency treegraph
 
Reported: 2011-09-19 18:53 UTC by Olivier Finlay Beaton
Modified: 2011-09-19 19:21 UTC (History)
0 users

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


Attachments

Description Olivier Finlay Beaton 2011-09-19 18:53:20 UTC
It would also be invaluable if our doxygen docs included our global functions / properties, like wfMessage() for example. I hate having to dig into the code for what should be documented (and usually isn't in Manual:) 

At the very least if you turned on doc undoc'ed stuff (and we should!), it would give us the names of the functions (the plethora of wfMsg functions and their arguments). 

This would be a great start.

It would also allow you to include documentation on new Class based alternatives/replacements (pointing users in the right direction) and mark things as deprecated. 

Since our Manual: reference is such a disaster this could become better documented and could one-day supplant it.
Comment 1 Sam Reed (reedy) 2011-09-19 18:58:53 UTC
(In reply to comment #0)
> It would also be invaluable if our doxygen docs included our global functions /
> properties, like wfMessage() for example. I hate having to dig into the code
> for what should be documented (and usually isn't in Manual:) 
> 
> At the very least if you turned on doc undoc'ed stuff (and we should!), it
> would give us the names of the functions (the plethora of wfMsg functions and
> their arguments). 
> 
> This would be a great start.
> 
> It would also allow you to include documentation on new Class based
> alternatives/replacements (pointing users in the right direction) and mark
> things as deprecated. 
> 
> Since our Manual: reference is such a disaster this could become better
> documented and could one-day supplant it.

http://svn.wikimedia.org/doc/GlobalFunctions_8php.html

WFM, all methods are included. In the source wfHttpOnlySafe has no documentation, but is included [1]


[1] http://svn.wikimedia.org/doc/GlobalFunctions_8php.html#a816f51815f2d63c4f7db2b24105b3087
Comment 2 Olivier Finlay Beaton 2011-09-19 19:21:51 UTC
wow, my bad. I should dig deeper next time. Of course a search on the docs would of helped me there tons... which my other bug just got added!

So thank you! Any reason there isn't a "functions" tab at the top?

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


Navigation
Links