* Seems like an opportune time to introduce "@addtogroup Media" documentation tags.
* Merge "@addtogroup Metadata" (used by Exif.php) into "@addtogroup Media".
* Few more moving comment blocks to above classes.
require_once( 'AjaxFunctions.php' );
/**
- * @todo Document - e.g. Provide top-level description of this class.
+ * Object-Oriented Ajax functions.
* @addtogroup Ajax
*/
class AjaxDispatcher {
* This is a wrapper for APC's shared memory functions
*
*/
-
class APCBagOStuff extends BagOStuff {
function get($key) {
$val = apc_fetch($key);
}
}
+/**
+ * @todo document
+ */
class DBABagOStuff extends BagOStuff {
var $mHandler, $mFile, $mReader, $mWriter, $mDisabled;
*
* File format docs are available in source package for DjVuLibre:
* http://djvulibre.djvuzone.org/
+ *
+ * @addtogroup Media
*/
class DjVuImage {
function __construct( $filename ) {
<?php
/**
- * @addtogroup Metadata
+ * @addtogroup Media
*
* @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
* @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
/**
* @todo document (e.g. one-sentence class-overview description)
- * @addtogroup Metadata
+ * @addtogroup Media
*/
class Exif {
//@{
/**
* @todo document (e.g. one-sentence class-overview description)
- * @addtogroup Metadata
+ * @addtogroup Media
*/
class FormatExif {
/**
*/
/**
- * @todo document (needs one-sentence top-level class description + function descriptions).
+ * A base class for basic support for outputting syndication feeds in RSS and other formats.
*/
class FeedItem {
/**#@+
*
* Provides methods to retrieve paths (physical, logical, URL),
* to generate thumbnails or for uploading.
+ *
+ * @addtogroup Media
*/
class Image
{
} //class
+
+/**
+ * @addtogroup Media
+ */
class ArchivedFile
{
/**
*
* Add images to the gallery using add(), then render that list to HTML using toHTML().
*
+ * @addtogroup Media
*/
class ImageGallery
{
/**
* Special handling for image description pages
+ *
+ * @addtogroup Media
*/
class ImagePage extends Article {
/**
* @todo document
+ * @addtogroup Media
*/
class ImageHistoryList {
function ImageHistoryList( &$skin ) {
* These functions are used for primarily page content:
* links, embedded images, table of contents. Links are
* also used in the skin.
- */
-
-/**
* For the moment, Skin is a descendent class of Linker.
* In the future, it should probably be further split
* so that ever other bit of the wiki doesn't have to
* go loading up Skin to get at it.
*
+ * @addtogroup Skins
*/
class Linker {
function __construct() {}
/**
* Base class for the output of MediaHandler::doTransform() and Image::transform().
+ *
+ * @addtogroup Media
*/
abstract class MediaTransformOutput {
/**
/**
* Media transform output for images
+ *
+ * @addtogroup Media
*/
class ThumbnailImage extends MediaTransformOutput {
/**
/**
* Basic media transform error class
+ *
+ * @addtogroup Media
*/
class MediaTransformError extends MediaTransformOutput {
var $htmlMsg, $textMsg, $width, $height, $url, $path;
/**
* Shortcut class for parameter validation errors
+ *
+ * @addtogroup Media
*/
class TransformParameterError extends MediaTransformError {
function __construct( $params ) {
if(!extension_loaded('fileinfo')) dl('fileinfo.' . PHP_SHLIB_SUFFIX);
}
-/** Implements functions related to mime types such as detection and mapping to
-* file extension,
-*
-* Instances of this class are stateles, there only needs to be one global instance
-* of MimeMagic. Please use MimeMagic::singleton() to get that instance.
-*/
+/**
+ * Implements functions related to mime types such as detection and mapping to
+ * file extension.
+ *
+ * Instances of this class are stateles, there only needs to be one global instance
+ * of MimeMagic. Please use MimeMagic::singleton() to get that instance.
+ */
class MimeMagic {
/**
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
- *
- * @addtogroup SpecialPage
*/
/**
* @todo document, briefly.
+ * @addtogroup SpecialPage
*/
class ProtectionForm {
var $mRestrictions = array();
*/
/**
- * @todo document
+ * A simple method to retrieve the plain source of an article,
+ * using "action=raw" in the GET request string.
*/
class RawPage {
var $mArticle, $mTitle, $mRequest;
<?php
-/**
- * This is a class used to hold configuration settings, particularly for multi-wiki sites.
- *
- */
/**
* The include paths change after this file is included from commandLine.inc,
if (!defined('SITE_CONFIGURATION')) {
define('SITE_CONFIGURATION', 1);
+/**
+ * This is a class used to hold configuration settings, particularly for multi-wiki sites.
+ *
+ */
class SiteConfiguration {
var $suffixes = array();
var $wikis = array();
if ( ! defined( 'MEDIAWIKI' ) )
die( 1 );
-/**
- *
- * @addtogroup Skins
- */
-
# See skin.txt
/**
* The main skin class that provide methods and properties for all other skins.
* This base class is also the "Standard" skin.
+ *
+ * See docs/skin.txt for more information.
+ *
+ * @addtogroup Skins
*/
class Skin extends Linker {
/**#@+
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# http://www.gnu.org/copyleft/gpl.html
-/**
- * Template-filler skin base class
- * Formerly generic PHPTal (http://phptal.sourceforge.net/) skin
- * Based on Brion's smarty skin
- * Copyright (C) Gabriel Wicke -- http://www.aulinx.de/
- *
- * Todo: Needs some serious refactoring into functions that correspond
- * to the computations individual esi snippets need. Most importantly no body
- * parsing for most of those of course.
- *
- * @addtogroup Skins
- */
-
/**
* Wrapper object for MediaWiki's localization functions,
* to be passed to the template engine.
*
* @private
+ * @addtogroup Skins
*/
class MediaWiki_I18N {
var $_context = array();
}
/**
- * @todo document with one-sentence top-level class description.
+ * Template-filler skin base class
+ * Formerly generic PHPTal (http://phptal.sourceforge.net/) skin
+ * Based on Brion's smarty skin
+ * @copyright Copyright © Gabriel Wicke -- http://www.aulinx.de/
+ *
+ * @todo Needs some serious refactoring into functions that correspond
+ * to the computations individual esi snippets need. Most importantly no body
+ * parsing for most of those of course.
+ *
+ * @addtogroup Skins
*/
class SkinTemplate extends Skin {
/**#@+
* @addtogroup SpecialPage
*/
+/**
+ * Finds the user's contributions in the database that match the specified
+ * offset, limit, and namespace.
+ *
+ * @addtogroup SpecialPage
+ */
class ContribsFinder {
var $username, $offset, $limit, $namespace;
var $dbr;
$this->dbr->freeResult( $res );
return $contribs;
}
-};
+}
/**
* Special page "user contributions".
/**
* A special page listing redirects to redirecting page.
- * The software will not procede double redirects automaticly to prevent loops.
+ * The software will automatically not follow double redirects, to prevent loops.
* @addtogroup SpecialPage
*/
class DoubleRedirectsPage extends PageQueryPage {
}
/**
- * @todo document
+ * Implements the Special:Emailuser web interface, and invokes userMailer for sending the email message.
* @addtogroup SpecialPage
*/
class EmailUserForm {
}
/**
- *
+ * The User object encapsulates all of the user-specific settings (user_id,
+ * name, rights, password, email address, options, last login time). Client
+ * classes use the getXXX() functions to access these fields. These functions
+ * do all the work of determining whether the user is logged in,
+ * whether the requested option can be satisfied from cookies or
+ * whether a database query is needed. Most of the settings needed
+ * for rendering normal pages are set in the cookie to minimize use
+ * of the database.
*/
class User {
/**
* Fetch a scalar from the input or return $default if it's not set.
- * Returns a string. Arrays are discarded.
+ * Returns a string. Arrays are discarded. Useful for
+ * non-freeform text inputs (e.g. predefined internal text keys
+ * selected by a drop-down menu). For freeform input, see getText().
*
* @param string $name
* @param string $default optional default (or NULL)
* Fetch a text string from the given array or return $default if it's not
* set. \r is stripped from the text, and with some language modules there
* is an input transliteration applied. This should generally be used for
- * form <textarea> and <input> fields.
+ * form <textarea> and <input> fields. Used for user-supplied freeform text
+ * input (for which input transformations may be required - e.g. Esperanto
+ * x-coding).
*
* @param string $name
* @param string $default optional
* Handler for Microsoft bitmap format (bmp). It inherits most of the methods
* from ImageHandler, some of them had to be overriden cause gd does not
* support this format.
+ *
+ * @addtogroup Media
*/
class BmpHandler extends BitmapHandler {
<?php
+/**
+ * @addtogroup Media
+ */
class BitmapHandler extends ImageHandler {
function normaliseParams( $image, &$params ) {
global $wgMaxImageArea;
<?php
+/**
+ * @addtogroup Media
+ */
class DjVuHandler extends ImageHandler {
function isEnabled() {
global $wgDjvuRenderer, $wgDjvuDump, $wgDjvuToXML;
/**
* Base media handler class
+ *
+ * @addtogroup Media
*/
abstract class MediaHandler {
const TRANSFORM_LATER = 1;
/**
* Media handler abstract base class for images
+ *
+ * @addtogroup Media
*/
abstract class ImageHandler extends MediaHandler {
function validateParam( $name, $value ) {
<?php
+/**
+ * @addtogroup Media
+ */
class SvgHandler extends ImageHandler {
function isEnabled() {
global $wgSVGConverters, $wgSVGConverter;
* memcached client class implemented using (p)fsockopen()
*
* @author Ryan T. Dean <rtdean@cytherianage.net>
- * @addtogroup cache
+ * @addtogroup Cache
*/
class memcached
{
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# http://www.gnu.org/copyleft/gpl.html
-/**
- * Additional tests for UtfNormal::cleanUp() function, inclusion
- * regression checks for known problems.
- *
- * Requires PHPUnit.
- *
- * @addtogroup UtfNormal
- * @private
- */
if( php_sapi_name() != 'cli' ) {
die( "Run me from the command line please.\n" );
require_once 'UtfNormal.php';
/**
+ * Additional tests for UtfNormal::cleanUp() function, inclusion
+ * regression checks for known problems.
+ * Requires PHPUnit.
+ *
* @addtogroup UtfNormal
+ * @private
*/
class CleanUpTest extends PHPUnit_Framework_TestCase {
/** @todo document */
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# http://www.gnu.org/copyleft/gpl.html
-/**
- * Unicode normalization routines for working with UTF-8 strings.
- * Currently assumes that input strings are valid UTF-8!
- *
- * Not as fast as I'd like, but should be usable for most purposes.
- * UtfNormal::toNFC() will bail early if given ASCII text or text
- * it can quickly deterimine is already normalized.
- *
- * All functions can be called static.
- *
- * See description of forms at http://www.unicode.org/reports/tr15/
- *
- * @addtogroup UtfNormal
- */
-
/** */
require_once dirname(__FILE__).'/UtfNormalUtil.php';
define( 'NORMALIZE_ICU', function_exists( 'utf8_normalize' ) );
/**
+ * Unicode normalization routines for working with UTF-8 strings.
+ * Currently assumes that input strings are valid UTF-8!
+ *
+ * Not as fast as I'd like, but should be usable for most purposes.
+ * UtfNormal::toNFC() will bail early if given ASCII text or text
+ * it can quickly deterimine is already normalized.
*
+ * All functions can be called static.
+ *
+ * See description of forms at http://www.unicode.org/reports/tr15/
+ *
+ * @addtogroup UtfNormal
*/
class UtfNormal {
/**
*
* @param string $string a UTF-8 string
* @return string a clean, shiny, normalized UTF-8 string
- * @static
+ * @static
*/
static function cleanUp( $string ) {
if( NORMALIZE_ICU ) {
dépôts / lhc / web / wiklou.git / commitdiff