PHPDocumentor [http://en.wikipedia.org/wiki/PhpDocumentor] documentation tweaking...
authorNick Jenkins <nickj@users.mediawiki.org>
Wed, 28 Mar 2007 08:53:02 +0000 (08:53 +0000)
committerNick Jenkins <nickj@users.mediawiki.org>
Wed, 28 Mar 2007 08:53:02 +0000 (08:53 +0000)
commit5fef2333d43faed0571878e848d6c40ade2c9810
treeab939528c057e348c6a690be38dad5b06916ea51
parenta9760c1b92f830a691e9ce7e81c48f8cd9039305
PHPDocumentor [en.wikipedia.org/wiki/PhpDocumentor] documentation tweaking stuff.

Minor doc tweaks to prevent some PHPDocumentor warnings or errors when run on the includes/ directory. PHPDocumentor uses a syntax very similar to javadoc - mostly we already use this, but there were a few scattered places that were adjusted to make them consistent with the rest of the code. In practical terms, these changes were made:
* @url becomes @link
* @fixme becomes @todo
* HTML tags in descriptions must be closed / balanced.
* @bug was removed (where the bug was long fixed), or changed into a @todo (in the few situations where the bug was still pending)
* @obsolete becomes @deprecated
* Things like "/**@{{" and "/**@}}*/" which cause "unknown tag" warnings were removed
* @access must be a valid access level.
* @desc tag not needed, removed.
* Doesn't seem to like @licence, will accept @license however.
* Use full comment block notation in a few places (i.e. open block with "/**", start each line with " *", and end block with " */")

Then additional to this, to get some class docs associated with their respective classes:
* Moved some docs to right above those classes (deleting blank lines, or moving descriptions from the file headers)
* Marked some classes without docs as "@todo document"
* (done up to "class MIMEsearchPage" on the "classtrees_MediaWiki.html" page for the includes/ directory)
53 files changed:
includes/AjaxDispatcher.php
includes/AjaxResponse.php
includes/Article.php
includes/Categoryfinder.php
includes/ChangesList.php
includes/Database.php
includes/DatabaseOracle.php
includes/DateFormatter.php
includes/DefaultSettings.php
includes/DifferenceEngine.php
includes/DjVuImage.php
includes/EditPage.php
includes/Exif.php
includes/Feed.php
includes/FileStore.php
includes/GlobalFunctions.php
includes/HTMLCacheUpdate.php
includes/HistoryBlob.php
includes/IP.php
includes/JobQueue.php
includes/Licenses.php
includes/LinkCache.php
includes/LinksUpdate.php
includes/LogPage.php
includes/OutputPage.php
includes/Parser.php
includes/ParserCache.php
includes/ProfilerSimple.php
includes/ProfilerSimpleUDP.php
includes/ProtectionForm.php
includes/Sanitizer.php
includes/SkinTemplate.php
includes/SpecialAncientpages.php
includes/SpecialBlockip.php
includes/SpecialEmailuser.php
includes/SpecialImport.php
includes/SpecialIpblocklist.php
includes/SpecialListredirects.php
includes/SpecialLockdb.php
includes/SpecialLog.php
includes/SpecialMIMEsearch.php
includes/SpecialMovepage.php
includes/SpecialProtectedpages.php
includes/SpecialRandomredirect.php
includes/SpecialUndelete.php
includes/SpecialUserlogin.php
includes/SpecialVersion.php
includes/Title.php
includes/User.php
includes/UserMailer.php
includes/WebRequest.php
includes/api/ApiBase.php
includes/api/ApiFormatYaml_spyc.php