prevents some doxygen warnings

This patch fix misc issues reported by doxygen. Nothing fancy.

Change-Id: I98edc8c877019f1dc4a82a37bca518df2eb904fc
This commit is contained in:
Antoine Musso 2012-07-15 22:32:48 +02:00
parent 5446238520
commit ef9534313e
8 changed files with 23 additions and 15 deletions

View file

@ -73,7 +73,8 @@ interface ICacheHelper {
function saveCache();
/**
* Sets the time to live for the cache, in seconds or a unix timestamp indicating the point of expiry..
* Sets the time to live for the cache, in seconds or a unix timestamp
* indicating the point of expiry...
*
* @since 1.20
*
@ -319,7 +320,8 @@ class CacheHelper implements ICacheHelper {
}
/**
* Sets the time to live for the cache, in seconds or a unix timestamp indicating the point of expiry..
* Sets the time to live for the cache, in seconds or a unix timestamp
* indicating the point of expiry...
*
* @since 1.20
*

View file

@ -3207,7 +3207,7 @@ function wfUseMW( $req_ver ) {
* http://bugs.php.net/bug.php?id=33898
*
* PHP's basename() only considers '\' a pathchar on Windows and Netware.
* We'll consider it so always, as we don't want \s in our Unix paths either.
* We'll consider it so always, as we don't want '\s' in our Unix paths either.
*
* @param $path String
* @param $suffix String: to remove if present

View file

@ -688,7 +688,7 @@ class HTMLForm extends ContextSource {
/**
* Format a stack of error messages into a single HTML string
* @param $errors Array of message keys/values
* @return String HTML, a <ul> list of errors
* @return String HTML, a "<ul>" list of errors
*/
public static function formatErrors( $errors ) {
$errorstr = '';
@ -1991,7 +1991,7 @@ class HTMLSelectAndOtherField extends HTMLSelectField {
/**
* @param $request WebRequest
* @return Array( <overall message>, <select value>, <text field value> )
* @return Array("<overall message>","<select value>","<text field value>")
*/
function loadDataFromRequest( $request ) {
if ( $request->getCheck( $this->mName ) ) {

View file

@ -1699,17 +1699,22 @@ abstract class BaseTemplate extends QuickTemplate {
}
/**
* Generates a list item for a navigation, portlet, portal, sidebar... etc list
* $key is a string, usually a key from the list you are generating this link from
* $item is an array of list item data containing some of a specific set of keys.
* Generates a list item for a navigation, portlet, portal, sidebar... list
*
* @param $key string, usually a key from the list you are generating this link from.
* @param $item array, of list item data containing some of a specific set of keys.
* The "id" and "class" keys will be used as attributes for the list item,
* if "active" contains a value of true a "active" class will also be appended to class.
* If you want something other than a <li> you can pass a tag name such as
*
* @param $options array
*
* If you want something other than a "<li>" you can pass a tag name such as
* "tag" => "span" in the $options array to change the tag used.
* link/content data for the list item may come in one of two forms
* A "links" key may be used, in which case it should contain an array with
* a list of links to include inside the list item, see makeLink for the format
* of individual links array items.
* a list of links to include inside the list item, see makeLink for the
* format of individual links array items.
*
* Otherwise the relevant keys from the list item $item array will be passed
* to makeLink instead. Note however that "id" and "class" are used by the
* list item directly so they will not be passed to makeLink
@ -1717,6 +1722,7 @@ abstract class BaseTemplate extends QuickTemplate {
* If you need an id or class on a single link you should include a "links"
* array with just one link item inside of it.
* $options is also passed on to makeLink calls
*
* @return string
*/
function makeListItem( $key, $item, $options = array() ) {

View file

@ -32,7 +32,7 @@ class ProcessCacheLRU {
protected $maxCacheKeys; // integer; max entries
/**
* @param $maxEntries integer Maximum number of entries allowed (min 1).
* @param $maxKeys integer Maximum number of entries allowed (min 1).
* @throws MWException When $maxCacheKeys is not an int or =< 0.
*/
public function __construct( $maxKeys ) {

View file

@ -558,7 +558,7 @@ abstract class Installer {
* write your messages. This appears to work well enough. Basic formatting and
* external links work just fine.
*
* But in case a translator decides to throw in a #ifexist or internal link or
* But in case a translator decides to throw in a "#ifexist" or internal link or
* whatever, this function is guarded to catch the attempted DB access and to present
* some fallback text.
*

View file

@ -124,7 +124,7 @@ class SearchOracle extends SearchEngine {
/**
* Return a LIMIT clause to limit results on the query.
*
* @param string
* @param $sql string
*
* @return String
*/

View file

@ -71,7 +71,7 @@ class SpecialProtectedpages extends SpecialPage {
/**
* Callback function to output a restriction
* @param Title $row Protected title
* @return string Formatted <li> element
* @return string Formatted "<li>" element
*/
public function formatRow( $row ) {
wfProfileIn( __METHOD__ );