Some small doc tweaks to reduce Doxygen warnings, namely:
authorNick Jenkins <nickj@users.mediawiki.org>
Wed, 18 Apr 2007 09:50:10 +0000 (09:50 +0000)
committerNick Jenkins <nickj@users.mediawiki.org>
Wed, 18 Apr 2007 09:50:10 +0000 (09:50 +0000)
commit9648f3b4d0f55e0767fd24f3ec2b2b03985d78c0
tree9f3f280dd85297cad00a93a293f2ce230d330b71
parented7a6ceecee84e93a2549fd273bf74f550a21307
Some small doc tweaks to reduce Doxygen warnings, namely:
* @link. You might think @link would surely mean "here comes a web URL" ... but @link is a valid command
  in Doxygen, which means an entirely different kind of link (an internal link to somewhere, so that you can separate
  documentation and implementation). The result is a mess, and the best solution I can see is to use "@see" instead of "@link".
* Warning: argument `nourl' of command @param is not found in the argument list of Linker::makeMediaLinkObj($title,$text='')
* Moving few class descriptions to right above classes, and/or formatting into Javadoc style.
* "@addtogroup Special Pages" --> "@addtogroup SpecialPage" so that all special pages have the same @addtogroup tag.
* @fixme --> @todo (must have missed these before)
* "@param $specialPage @see" remove the "@" in the "@see" to stop warning.
* @throws wants type, then a brief description, to stop warning.

This last one is for PHPdocumentor only, but it fixes something for PHPDocumentor, and should be neutral for Doxygen:
* WARNING in includes/api/ApiFormatYaml_spyc.php on line 860: docblock template never terminated with /**#@-*/
26 files changed:
includes/BagOStuff.php
includes/Categoryfinder.php
includes/DatabaseOracle.php
includes/DatabasePostgres.php
includes/Exif.php
includes/Export.php
includes/GlobalFunctions.php
includes/IP.php
includes/Image.php
includes/Linker.php
includes/Sanitizer.php
includes/SpecialAllpages.php
includes/SpecialBooksources.php
includes/SpecialConfirmemail.php
includes/SpecialContributions.php
includes/SpecialRandomredirect.php
includes/SpecialRecentchanges.php
includes/SpecialResetpass.php
includes/SpecialUncategorizedimages.php
includes/SpecialUndelete.php
includes/SpecialUnusedtemplates.php
includes/SpecialUserlogin.php
includes/SpecialUserrights.php
includes/api/ApiFormatJson_json.php
includes/api/ApiFormatYaml_spyc.php
includes/api/ApiMain.php