/**
* Make an array of titles from an array of IDs
- * @param $ids \arrayof{\int} Array of IDs
- * @return \arrayof{Title} Array of Titles
+ * @param $ids \type{\arrayof{\int}} Array of IDs
+ * @return \type{\arrayof{Title}} Array of Titles
*/
public static function newFromIDs( $ids ) {
if ( !count( $ids ) ) {
* there's a fragment but the prefixed text is empty, we just return a link
* to the fragment.
*
- * @param $query \arrayof{\string} An associative array of key => value pairs for the
+ * @param $query \type{\arrayof{\string}} An associative array of key => value pairs for the
* query string. Keys and values will be escaped.
* @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored
* for external links. Default is "false" (same variant as current page,
/**
* Can $wgUser perform $action on this page?
- * @param \type{\string} $action action that permission needs to be checked for
+ * @param $action \type{\string} action that permission needs to be checked for
* @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
* @return \type{\bool}
*/
* @param $action \type{\string}action that permission needs to be checked for
* @param $user \type{User} user to check
* @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
- * @param $ignoreErrors \arrayof{\string} Set this to a list of message keys whose corresponding errors may be ignored.
+ * @param $ignoreErrors \type{\arrayof{\string}} Set this to a list of message keys whose corresponding errors may be ignored.
* @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
*/
public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
* Cascading protection: Get the source of any cascading restrictions on this page.
*
* @param $get_pages \type{\bool} Whether or not to retrieve the actual pages that the restrictions have come from.
- * @return \arrayof{mixed title array, restriction array} Array of the Title objects of the pages from
+ * @return \type{\arrayof{mixed title array, restriction array}} Array of the Title objects of the pages from
* which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set.
* The restriction array is an array of each type, each of which contains an array of unique groups.
*/
* Accessor/initialisation for mRestrictions
*
* @param $action \type{\string} action that permission needs to be checked for
- * @return \arrayof{\string} the array of groups allowed to edit this article
+ * @return \type{\arrayof{\string}} the array of groups allowed to edit this article
*/
public function getRestrictions( $action ) {
if( !$this->mRestrictionsLoaded ) {
* On heavily-used templates it will max out the memory.
*
* @param $options \type{\string} may be FOR UPDATE
- * @return \arrayof{Title} the Title objects linking here
+ * @return \type{\arrayof{Title}} the Title objects linking here
*/
public function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
$linkCache = LinkCache::singleton();
* On heavily-used templates it will max out the memory.
*
* @param $options \type{\string} may be FOR UPDATE
- * @return \arrayof{Title} the Title objects linking here
+ * @return \type{\arrayof{Title}} the Title objects linking here
*/
public function getTemplateLinksTo( $options = '' ) {
return $this->getLinksTo( $options, 'templatelinks', 'tl' );
*
* @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
* @param $options \type{\string} may be FOR UPDATE
- * @return \arrayof{Title} the Title objects
+ * @return \type{\arrayof{Title}} the Title objects
*/
public function getBrokenLinksFrom( $options = '' ) {
if ( $this->getArticleId() == 0 ) {
* Get a list of URLs to purge from the Squid cache when this
* page changes
*
- * @return \arrayof{\string} the URLs
+ * @return \type{\arrayof{\string}} the URLs
*/
public function getSquidURLs() {
global $wgContLang;
*
* @param $ns \twotypes{\int,\null} Single namespace to consider;
* NULL to consider all namespaces
- * @return \arrayof{Title} Redirects to this title
+ * @return \type{\arrayof{Title}} Redirects to this title
*/
public function getRedirectsHere( $ns = null ) {
$redirs = array();
class User {
/**
- * \arrayof{\string} A list of default user toggles, i.e., boolean user
+ * \type{\arrayof{\string}} A list of default user toggles, i.e., boolean user
* preferences that are displayed by Special:Preferences as checkboxes.
* This list can be extended via the UserToggles hook or by
* $wgContLang::getExtraUserToggles().
);
/**
- * \arrayof{\string} List of member variables which are saved to the
+ * \type{\arrayof{\string}} List of member variables which are saved to the
* shared cache (memcached). Any operation which changes the
* corresponding database fields must call a cache-clearing function.
* @showinitializer
);
/**
- * \arrayof{\string} Core rights.
+ * \type{\arrayof{\string}} Core rights.
* Each of these should have a corresponding message of the form
* "right-$right".
* @showinitializer
/**
* Initialize this object from a row from the user table.
*
- * @param $row \arrayof{\mixed} Row from the user table to load.
+ * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
*/
function loadFromRow( $row ) {
$this->mDataLoaded = true;
* Combine the language default options with any site-specific options
* and add the default language variants.
*
- * @return \arrayof{\string} Array of options
+ * @return \type{\arrayof{\string}} Array of options
*/
static function getDefaultOptions() {
global $wgNamespacesToBeSearchedDefault;
/**
* Get a list of user toggle names
- * @return \arrayof{\string} Array of user toggle names
+ * @return \type{\arrayof{\string}} Array of user toggle names
*/
static function getToggles() {
global $wgContLang;
/**
* Return the talk page(s) this user has new messages on.
- * @return \arrayof{\string} Array of page URLs
+ * @return \type{\arrayof{\string}} Array of page URLs
*/
function getNewMessageLinks() {
$talks = array();
/**
* Get the permissions this user has.
- * @return \arrayof{\string} Array of permission names
+ * @return \type{\arrayof{\string}} Array of permission names
*/
function getRights() {
if ( is_null( $this->mRights ) ) {
/**
* Get the list of explicit group memberships this user has.
* The implicit * and user groups are not included.
- * @return \arrayof{\string} Array of internal group names
+ * @return \type{\arrayof{\string}} Array of internal group names
*/
function getGroups() {
$this->load();
* '*' for all accounts and autopromoted groups
*
* @param $recache \type{\bool} Whether to avoid the cache
- * @return \arrayof{\string} Array of internal group names
+ * @return \type{\arrayof{\string}} Array of internal group names
*/
function getEffectiveGroups( $recache = false ) {
if ( $recache || is_null( $this->mEffectiveGroups ) ) {
* Add a user to the database, return the user object
*
* @param $name \type{\string} Username to add
- * @param $params \arrayof{\string} Non-default parameters to save to the database:
+ * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
* - password The user's password. Password logins will be disabled if this is omitted.
* - newpassword A temporary password mailed to the user
* - email The user's email address
/**
* Get the permissions associated with a given list of groups
*
- * @param $groups \arrayof{\string} List of internal group names
- * @return \arrayof{\string} List of permission key names for given groups combined
+ * @param $groups \type{\arrayof{\string}} List of internal group names
+ * @return \type{\arrayof{\string}} List of permission key names for given groups combined
*/
static function getGroupPermissions( $groups ) {
global $wgGroupPermissions;
* Get all the groups who have a given permission
*
* @param $role \type{\string} Role to check
- * @return \arrayof{\string} List of internal group names with the given permission
+ * @return \type{\arrayof{\string}} List of internal group names with the given permission
*/
static function getGroupsWithPermission( $role ) {
global $wgGroupPermissions;
* Return the set of defined explicit groups.
* The implicit groups (by default *, 'user' and 'autoconfirmed')
* are not included, as they are defined automatically, not in the database.
- * @return \arrayof{\string} Array of internal group names
+ * @return \type{\arrayof{\string}} Array of internal group names
*/
static function getAllGroups() {
global $wgGroupPermissions;
/**
* Get a list of all available permissions.
- * @return \arrayof{\string} Array of permission names
+ * @return \type{\arrayof{\string}} Array of permission names
*/
static function getAllRights() {
if ( self::$mAllRights === false ) {
/**
* Get a list of implicit groups
- * @return \arrayof{\string} Array of internal group names
+ * @return \type{\arrayof{\string}} Array of internal group names
*/
public static function getImplicitGroups() {
global $wgImplicitGroups;
-# Doxyfile 1.5.5
+# Doxyfile 1.5.6
#
# Some placeholders have been added for MediaWiki usage:
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
-TAB_SIZE = 4
-#ALIASES =
+TAB_SIZE = 8
+ALIASES = \
+ "type{1}=<b>\1</b>:" \
+ "twotypes{2}=<b>\1</b> or <b>\2</b>:" \
+ "threetypes{3}=<b>\1</b>, <b>\2</b>, or <b>\3</b>:" \
+ "arrayof{1}=<b>Array</b> of <b>\1</b>" \
+ "null=Null" \
+ "boolean=Boolean" \
+ "bool=\boolean" \
+ "integer=Integer" \
+ "int=\integer" \
+ "string=String" \
+ "str=\string" \
+ "array=Array" \
+ "mixed=Mixed"
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = NO
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
-HIDE_IN_BODY_DOCS = NO
+HIDE_IN_BODY_DOCS = YES
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
-
-ALIASES = "type{1}=<b>\1</b>:" \
- "twotypes{2}=<b>\1</b> or <b>\2</b>:" \
- "threetypes{3}=<b>\1</b>, <b>\2</b>, or <b>\3</b>:" \
- "arrayof{1}=<b>Array</b> of <b>\1</b>:" \
- "null=Null" \
- "boolean=Boolean" \
- "bool=\boolean" \
- "integer=Integer" \
- "int=\integer" \
- "string=String" \
- "str=\string" \
- "array=Array" \
- "mixed=Mixed"
dépôts / lhc / web / wiklou.git / commitdiff