| commit | 0c3fd14073e6ef3c3e24450289734914e288b57d | |
| author | Brad Jorsch <bjorsch@wikimedia.org> | |
| Wed, 25 Nov 2015 16:32:14 +0000 (25 11:32 -0500) | ||
| committer | Brad Jorsch <bjorsch@wikimedia.org> | |
| Wed, 25 Nov 2015 16:54:07 +0000 (25 11:54 -0500) | ||
| tree | 1b843a8ebe4efa1f03049d4ca00a49c18001227d | treesnapshot (tar.gz zip) |
| parent | 186a41c3c5bb9d8e1480fb9a024ef2f80f439323 | commitdiff |
Update ApiBase::PARAM_* comments
Put them in a form that doxygen should recognize,[1] and document all the
types recognized for PARAM_TYPE.
Ideally we'd use some @-thing like @var to specify the types instead of
just a weird parenthetical, but looking at existing examples it seems
that putting @var on a class constant will instead make doxygen
completely ignore it.
[1]: See https://doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html
Change-Id: Iccfa1dc9a7a79313ff9acf71934264c115b3fa76
Put them in a form that doxygen should recognize,[1] and document all the
types recognized for PARAM_TYPE.
Ideally we'd use some @-thing like @var to specify the types instead of
just a weird parenthetical, but looking at existing examples it seems
that putting @var on a class constant will instead make doxygen
completely ignore it.
[1]: See https://doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html
Change-Id: Iccfa1dc9a7a79313ff9acf71934264c115b3fa76
| includes/api/ApiBase.php | diffblobblamehistory |