Page MenuHomePhabricator

Functions / Properties should go into our doxygen docs + undoc'ed added
Closed, DeclinedPublic

Description

Author: olivier.beaton

Description:
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.


Version: unspecified
Severity: major

Details

Reference
bz31005

Event Timeline

bzimport raised the priority of this task from to Needs Triage.Nov 21 2014, 11:52 PM
bzimport set Reference to bz31005.
bzimport added a subscriber: Unknown Object (MLST).

(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

olivier.beaton wrote:

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?