Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

miscellaneous doxygen warnings

Browse source 
* @licence -> @license
* Protects inline HTML by using double quotes, our inline comments uses
  elements such as <h1> or <firstnameLastname@gmail.com>
* Commands in lowercase (@TODO -> @todo, @NOTE -> @note)
* removes @abstract and @static since doxygen detects them from PHP
  code.
* various undocumented function parameters
* typos in parameters declarations

Change-Id: I62ad6fc124c355bf31acc780b9614a59cf79a421
This commit is contained in:
Antoine Musso 2012-10-22 12:29:52 +02:00
parent bde7fd0a19
commit 9362bb6c56
43 changed files with 84 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
includes/CacheHelper.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @licence GNU GPL v2 or later
* @license GNU GPL v2 or later
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/

1
includes/DataUpdate.php
View file

@ -74,7 +74,6 @@ abstract class DataUpdate implements DeferrableUpdate {
* This allows for limited transactional logic across multiple backends for storing
* secondary data.
*
* @static
* @param $updates array a list of DataUpdate instances
* @throws Exception|null
*/

2
includes/IP.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Antoine Musso <hashar at free dot fr>, Aaron Schulz
* @author Antoine Musso "<hashar at free dot fr>", Aaron Schulz
*/
// Some regex definition to "play" with IP address and IP address blocks

4
includes/Title.php
View file

@ -1369,6 +1369,8 @@ class Title {
*
* @see self::getLocalURL
* @see wfExpandUrl
* @param $query
* @param $query2 bool
* @param $proto Protocol type to use in URL
* @return String the URL
*/
@ -1495,6 +1497,8 @@ class Title {
*
* See getLocalURL for the arguments.
*
* @param $query
* @param $query2 bool
* @param $proto Protocol to use; setting this will cause a full URL to be used
* @see self::getLocalURL
* @return String the URL

4
includes/WebResponse.php
View file

@ -44,7 +44,7 @@ class WebResponse {
* @param $value String: value to give cookie
* @param $expire Int: number of seconds til cookie expires
* @param $prefix String: Prefix to use, if not $wgCookiePrefix (use '' for no prefix)
* @param @domain String: Cookie domain to use, if not $wgCookieDomain
* @param $domain String: Cookie domain to use, if not $wgCookieDomain
* @param $forceSecure Bool:
* true: force the cookie to be set with the secure attribute
* false: force the cookie to be set without the secure attribute
@ -149,7 +149,7 @@ class FauxResponse extends WebResponse {
* @param $expire Int: number of seconds til cookie expires (Default: 0)
* @param $prefix TODO DOCUMENT (Default: null)
* @param $domain TODO DOCUMENT (Default: null)
*
* @param $forceSecure TODO DOCUMENT (Default: null)
*/
public function setcookie( $name, $value, $expire = 0, $prefix = null, $domain = null, $forceSecure = null ) {
$this->cookies[$name] = $value;

3
includes/WikiPage.php
View file

@ -1447,7 +1447,7 @@ class WikiPage extends Page implements IDBAccessObject {
/**
* @param $section null|bool|int or a section number (0, 1, 2, T1, T2...)
* @param $content Content: new content of the section
* @param $sectionContent Content: new content of the section
* @param $sectionTitle String: new section's subject, only if $section is 'new'
* @param $edittime String: revision timestamp or null to use the current revision
*
@ -2450,6 +2450,7 @@ class WikiPage extends Page implements IDBAccessObject {
* @param $reason string delete reason for deletion log
* @param $suppress boolean suppress all revisions and log the deletion in
* the suppression log instead of the deletion log
* @param $id int article ID
* @param $commit boolean defaults to true, triggers transaction end
* @param &$error Array of errors to append to
* @param $user User The deleting user

4
includes/actions/InfoAction.php
View file

@ -582,7 +582,7 @@ class InfoAction extends FormlessAction {
}
/**
* Returns the name that goes in the <h1> page title.
* Returns the name that goes in the "<h1>" page title.
*
* @return string
*/
@ -653,7 +653,7 @@ class InfoAction extends FormlessAction {
}
/**
* Returns the description that goes below the <h1> tag.
* Returns the description that goes below the "<h1>" tag.
*
* @return string
*/

2
includes/api/ApiFormatNone.php
View file

@ -4,7 +4,7 @@
*
* Created on Oct 22, 2006
*
* Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by

2
includes/api/ApiQueryORM.php
View file

@ -23,7 +23,7 @@
* @file
* @ingroup API
*
* @licence GNU GPL v2+
* @license GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
abstract class ApiQueryORM extends ApiQueryBase {

2
includes/cache/CacheDependency.php vendored
View file

@ -74,7 +74,7 @@ class DependencyWrapper {
/**
* Get the user-defined value
* @return bool|\Mixed
* @return bool|Mixed
*/
function getValue() {
return $this->value;

4
includes/content/AbstractContent.php
View file

@ -381,8 +381,8 @@ abstract class AbstractContent implements Content {
*
* @since 1.21
*
* @param $page \WikiPage the deleted page
* @param $parserOutput null|\ParserOutput optional parser output object
* @param $page WikiPage the deleted page
* @param $parserOutput null|ParserOutput optional parser output object
* for efficient access to meta-information about the content object.
* Provide if you have one handy.
*

12
includes/content/Content.php
View file

@ -45,10 +45,10 @@ interface Content {
* @return string The wikitext to include when another page includes this
* content, or false if the content is not includable in a wikitext page.
*
* @TODO: allow native handling, bypassing wikitext representation, like
* @todo allow native handling, bypassing wikitext representation, like
* for includable special pages.
* @TODO: allow transclusion into other content models than Wikitext!
* @TODO: used in WikiPage and MessageCache to get message text. Not so
* @todo allow transclusion into other content models than Wikitext!
* @todo used in WikiPage and MessageCache to get message text. Not so
* nice. What should we use instead?!
*/
public function getWikitextForTransclusion();
@ -74,7 +74,7 @@ interface Content {
* string, a nested array structure, an object, a binary blob...
* anything, really.
*
* @NOTE: Caller must be aware of content model!
* @note Caller must be aware of content model!
*/
public function getNativeData();
@ -460,8 +460,8 @@ interface Content {
*
* @since 1.21
*
* @param $page \WikiPage the deleted page
* @param $parserOutput null|\ParserOutput optional parser output object
* @param $page WikiPage the deleted page
* @param $parserOutput null|ParserOutput optional parser output object
* for efficient access to meta-information about the content object.
* Provide if you have one handy.
*

10
includes/content/ContentHandler.php
View file

@ -80,7 +80,6 @@ abstract class ContentHandler {
*
* @since 1.21
*
* @static
* @param $content Content|null
* @return null|string the textual form of $content, if available
* @throws MWException if $content is not an instance of TextContent and
@ -123,8 +122,6 @@ abstract class ContentHandler {
*
* @since 1.21
*
* @static
*
* @param $text string the textual representation, will be
* unserialized to create the Content object
* @param $title null|Title the title of the page this text belongs to.
@ -184,7 +181,6 @@ abstract class ContentHandler {
*
* @since 1.21
*
* @static
* @param $title Title
* @return null|string default model name for the page given by $title
*/
@ -256,7 +252,6 @@ abstract class ContentHandler {
*
* @since 1.21
*
* @static
* @param $title Title
* @return ContentHandler
*/
@ -271,7 +266,6 @@ abstract class ContentHandler {
*
* @since 1.21
*
* @static
* @param $content Content
* @return ContentHandler
*/
@ -304,7 +298,6 @@ abstract class ContentHandler {
*
* @since 1.21
*
* @static
* @param $modelId String The ID of the content model for which to get a
* handler. Use CONTENT_MODEL_XXX constants.
* @return ContentHandler The ContentHandler singleton for handling the
@ -352,7 +345,6 @@ abstract class ContentHandler {
* Model names are localized using system messages. Message keys
* have the form content-model-$name, where $name is getContentModelName( $id ).
*
* @static
* @param $name String The content model ID, as given by a CONTENT_MODEL_XXX
* constant or returned by Revision::getContentModel().
*
@ -415,7 +407,6 @@ abstract class ContentHandler {
*
* @since 1.21
*
* @abstract
* @param $content Content The Content object to serialize
* @param $format null|String The desired serialization format
* @return string Serialized form of the content
@ -427,7 +418,6 @@ abstract class ContentHandler {
*
* @since 1.21
*
* @abstract
* @param $blob string serialized form of the content
* @param $format null|String the format used for serialization
* @return Content the Content object created by deserializing $blob

15
includes/content/TextContent.php
View file

@ -91,7 +91,7 @@ class TextContent extends AbstractContent {
/**
* Returns the text represented by this Content object, as a string.
*
* @param the raw text
* @return string: the raw text
*/
public function getNativeData( ) {
$text = $this->mText;
@ -101,7 +101,7 @@ class TextContent extends AbstractContent {
/**
* Returns the text represented by this Content object, as a string.
*
* @param the raw text
* @return string: the raw text
*/
public function getTextForSearchIndex( ) {
return $this->getNativeData();
@ -110,7 +110,7 @@ class TextContent extends AbstractContent {
/**
* Returns the text represented by this Content object, as a string.
*
* @param the raw text
* @return string: the raw text
*/
public function getWikitextForTransclusion( ) {
return $this->getNativeData();
@ -133,15 +133,16 @@ class TextContent extends AbstractContent {
}
/**
* Diff this content object with another content object..
* Diff this content object with another content object.
*
* @since 1.21diff
*
* @param $that Content the other content object to compare this content object to
* @param $lang Language the language object to use for text segmentation.
* @param $that Content: The other content object to compare this content
* object to.
* @param $lang Language: The language object to use for text segmentation.
* If not given, $wgContentLang is used.
*
* @return DiffResult a diff representing the changes that would have to be
* @return DiffResult: A diff representing the changes that would have to be
* made to this content object to make it equal to $that.
*/
public function diff( Content $that, Language $lang = null ) {

8
includes/content/TextContentHandler.php
View file

@ -30,9 +30,9 @@ class TextContentHandler extends ContentHandler {
*
* This text-based implementation uses wfMerge().
*
* @param $oldContent \Content|string String
* @param $myContent \Content|string String
* @param $yourContent \Content|string String
* @param $oldContent Content|string String
* @param $myContent Content|string String
* @param $yourContent Content|string String
*
* @return Content|Bool
*/
@ -87,4 +87,4 @@ class TextContentHandler extends ContentHandler {
public function makeEmptyContent() {
return new TextContent( '' );
}
}
}

13
includes/content/WikitextContent.php
View file

@ -212,8 +212,8 @@ class WikitextContent extends TextContent {
*
* @param $hasLinks Bool if it is known whether this content contains
* links, provide this information here, to avoid redundant parsing to
* find out.
* @param $title null|\Title
* find out (default: null).
* @param $title Title: (default: null)
*
* @internal param \IContextSource $context context for parsing if necessary
*
@ -268,11 +268,10 @@ class WikitextContent extends TextContent {
*
* @since 1.21
*
* @param $content Content the content to render
* @param $title \Title
* @param $revId null
* @param $options null|ParserOptions
* @param $generateHtml bool
* @param $title Title
* @param $revId int Revision to pass to the parser (default: null)
* @param $options ParserOptions (default: null)
* @param $generateHtml bool (default: false)
*
* @internal param \IContextSource|null $context
* @return ParserOutput representing the HTML form of the text

2
includes/db/DatabaseIbm_db2.php
View file

@ -1183,7 +1183,7 @@ class DatabaseIbm_db2 extends DatabaseBase {
* @param array|string $conds
* @param string $fname
* @throws DBUnexpectedError
* @return bool|\ResultWrapper
* @return bool|ResultWrapper
*/
public function delete( $table, $conds, $fname = 'DatabaseIbm_db2::delete' ) {
if ( !$conds ) {

2
includes/db/DatabaseMssql.php
View file

@ -528,7 +528,7 @@ class DatabaseMssql extends DatabaseBase {
* @param array $insertOptions
* @param array $selectOptions
* @throws DBQueryError
* @return null|\ResultWrapper
* @return null|ResultWrapper
*/
function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabaseMssql::insertSelect',
$insertOptions = array(), $selectOptions = array() ) {

2
includes/db/IORMRow.php
View file

@ -27,7 +27,7 @@
* @file
* @ingroup ORM
*
* @licence GNU GPL v2 or later
* @license GNU GPL v2 or later
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/

2
includes/db/IORMTable.php
View file

@ -23,7 +23,7 @@
* @file
* @ingroup ORM
*
* @licence GNU GPL v2 or later
* @license GNU GPL v2 or later
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/

2
includes/db/ORMIterator.php
View file

@ -23,7 +23,7 @@
* @file
* @ingroup ORM
*
* @licence GNU GPL v2 or later
* @license GNU GPL v2 or later
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
interface ORMIterator extends Iterator {

2
includes/db/ORMResult.php
View file

@ -25,7 +25,7 @@
* @file ORMResult.php
* @ingroup ORM
*
* @licence GNU GPL v2 or later
* @license GNU GPL v2 or later
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/

9
includes/db/ORMRow.php
View file

@ -27,7 +27,7 @@
* @file ORMRow.php
* @ingroup ORM
*
* @licence GNU GPL v2 or later
* @license GNU GPL v2 or later
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
@ -138,8 +138,9 @@ abstract class ORMRow implements IORMRow {
*
* @since 1.20
*
* @param string $name
* @param mixed $default
* @param $name string: Field name
* @param $default mixed: Default value to return when none is found
* (default: null)
*
* @throws MWException
* @return mixed
@ -159,7 +160,7 @@ abstract class ORMRow implements IORMRow {
*
* @since 1.20
*
* @param string$name
* @param $name string
*
* @return mixed
*/

2
includes/db/ORMTable.php
View file

@ -23,7 +23,7 @@
* @file ORMTable.php
* @ingroup ORM
*
* @licence GNU GPL v2 or later
* @license GNU GPL v2 or later
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/

1
includes/debug/Debug.php
View file

@ -135,6 +135,7 @@ class MWDebug {
* @since 1.19
* @param $msg string
* @param $callerOffset int
* @param $level int A PHP error level. See sendWarning()
* @return mixed
*/
public static function warning( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {

4
includes/filebackend/SwiftFileBackend.php
View file

@ -1216,10 +1216,10 @@ class SwiftFileBackend extends FileBackendStore {
* $readGrps is a list of the possible criteria for a request to have
* access to read a container. Each item is one of the following formats:
* - account:user : Grants access if the request is by the given user
* - .r:<regex> : Grants access if the request is from a referrer host that
* - ".r:<regex>" : Grants access if the request is from a referrer host that
* matches the expression and the request is not for a listing.
* Setting this to '*' effectively makes a container public.
* - .rlistings:<regex> : Grants access if the request is from a referrer host that
* -".rlistings:<regex>": Grants access if the request is from a referrer host that
* matches the expression and the request for a listing.
*
* $writeGrps is a list of the possible criteria for a request to have

9
includes/installer/WebInstaller.php
View file

@ -56,10 +56,11 @@ class WebInstaller extends Installer {
/**
* The main sequence of page names. These will be displayed in turn.
* To add one:
* * Add it here
* * Add a config-page-<name> message
* * Add a WebInstaller_<name> class
*
* To add a new installer page:
* * Add it to this WebInstaller::$pageSequence property
* * Add a "config-page-<name>" message
* * Add a "WebInstaller_<name>" class
* @var array
*/
public $pageSequence = array(

2
includes/libs/GenericArrayObject.php
View file

@ -29,7 +29,7 @@
*
* @file
*
* @licence GNU GPL v2+
* @license GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
abstract class GenericArrayObject extends ArrayObject {

2
includes/resourceloader/ResourceLoader.php
View file

@ -873,7 +873,7 @@ class ResourceLoader {
* Combines an associative array mapping media type to CSS into a
* single stylesheet with "@media" blocks.
*
* @param $styles Array: Array keyed by media type containing (arrays of) CSS strings.
* @param $stylePairs Array: Array keyed by media type containing (arrays of) CSS strings.
*
* @return Array
*/

2
includes/search/SearchEngine.php
View file

@ -163,7 +163,7 @@ class SearchEngine {
/**
* Really find the title match.
* @return null|\Title
* @return null|Title
*/
private static function getNearMatchInternal( $searchterm ) {
global $wgContLang, $wgEnableSearchContributorsByIP;

4
includes/search/SearchMssql.php
View file

@ -192,7 +192,7 @@ class SearchMssql extends SearchEngine {
* @param $id Integer
* @param $title String
* @param $text String
* @return bool|\ResultWrapper
* @return bool|ResultWrapper
*/
function update( $id, $title, $text ) {
// We store the column data as UTF-8 byte order marked binary stream
@ -215,7 +215,7 @@ class SearchMssql extends SearchEngine {
*
* @param $id Integer
* @param $title String
* @return bool|\ResultWrapper
* @return bool|ResultWrapper
*/
function updateTitle( $id, $title ) {
$table = $this->db->tableName( 'searchindex' );

4
includes/site/MediaWikiSite.php
View file

@ -8,7 +8,7 @@
* @file
* @ingroup Site
*
* @licence GNU GPL v2+
* @license GNU GPL v2+
* @author John Erling Blad < jeblad@gmail.com >
* @author Daniel Kinzler
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
@ -282,7 +282,7 @@ class MediaWikiSite extends SiteObject {
*
* @since 1.21
*
* @param string|false
* @param $pagename string: Page name (default: false)
*
* @return string
*/

2
includes/site/Site.php
View file

@ -23,7 +23,7 @@
* @file
* @ingroup Site
*
* @licence GNU GPL v2+
* @license GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
interface Site {

2
includes/site/SiteArray.php
View file

@ -23,7 +23,7 @@
* @file
* @ingroup Site
*
* @licence GNU GPL v2+
* @license GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
class SiteArray extends GenericArrayObject implements SiteList {

2
includes/site/SiteList.php
View file

@ -23,7 +23,7 @@
* @file
* @ingroup Site
*
* @licence GNU GPL v2+
* @license GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
interface SiteList extends Countable, Traversable, Serializable, ArrayAccess {

2
includes/site/SiteObject.php
View file

@ -23,7 +23,7 @@
* @file
* @ingroup Site
*
* @licence GNU GPL v2+
* @license GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
* @author Daniel Werner
*/

2
includes/site/Sites.php
View file

@ -25,7 +25,7 @@
* @file
* @ingroup Site
*
* @licence GNU GPL v2+
* @license GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
class Sites {

2
includes/site/SitesTable.php
View file

@ -24,7 +24,7 @@
* @file
* @ingroup Site
*
* @licence GNU GPL v2+
* @license GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
class SitesTable extends ORMTable {

2
includes/specials/SpecialBooksources.php
View file

@ -63,7 +63,7 @@ class SpecialBookSources extends SpecialPage {
/**
* Returns whether a given ISBN (10 or 13) is valid. True indicates validity.
* @param isbn string ISBN passed for check
* @param $isbn string ISBN passed for check
* @return bool
*/
public static function isValidISBN( $isbn ) {

4
includes/specials/SpecialCachedPage.php
View file

@ -119,7 +119,7 @@ abstract class SpecialCachedPage extends SpecialPage implements ICacheHelper {
*
* @since 1.20
*
* @param {function} $computeFunction
* @param function $computeFunction
* @param array|mixed $args
* @param string|null $key
*
@ -137,7 +137,7 @@ abstract class SpecialCachedPage extends SpecialPage implements ICacheHelper {
*
* @since 1.20
*
* @param {function} $computeFunction
* @param function $computeFunction
* @param array $args
* @param string|null $key
*/

4
includes/specials/SpecialListusers.php
View file

@ -36,7 +36,9 @@ class UsersPager extends AlphabeticPager {
/**
* @param $context IContextSource
* @param $par null|array
* @param $par array (Default null)
* @param $including boolean Whether this page is being transcluded in
* another page
*/
function __construct( IContextSource $context = null, $par = null, $including = null ) {
if ( $context ) {

4
includes/upload/UploadStash.php
View file

@ -152,7 +152,7 @@ class UploadStash {
/**
* Getter for file metadata.
*
* @param key String: key under which file information is stored
* @param $key String: key under which file information is stored
* @return Array
*/
public function getMetadata ( $key ) {
@ -163,7 +163,7 @@ class UploadStash {
/**
* Getter for fileProps
*
* @param key String: key under which file information is stored
* @param $key String: key under which file information is stored
* @return Array
*/
public function getFileProps ( $key ) {

3
maintenance/Doxyfile
View file

@ -62,7 +62,8 @@ ALIASES = "type{1}=<b> \1 </b>:" \
"protected=\access protected" \
"public=\access public" \
"copyright=\note" \
"license=\note"
"license=\note" \
"codeCoverageIgnore="
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = NO