From 180b872c1b35129fd24339a528c9aeb7dc2f2805 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Thu, 25 Mar 2010 20:12:56 +0000 Subject: [PATCH] Fixed some doxygen warnings --- includes/filerepo/File.php | 45 +++++++++++++++--------------- includes/filerepo/LocalFile.php | 26 +++++++++-------- includes/filerepo/OldLocalFile.php | 15 +++++----- 3 files changed, 45 insertions(+), 41 deletions(-) diff --git a/includes/filerepo/File.php b/includes/filerepo/File.php index d79a166160..fdd61530c9 100644 --- a/includes/filerepo/File.php +++ b/includes/filerepo/File.php @@ -177,7 +177,8 @@ abstract class File { * Return a fully-qualified URL to the file. * Upload URL paths _may or may not_ be fully qualified, so * we check. Local paths are assumed to belong on $wgServer. - * @return string + * + * @return String */ public function getFullUrl() { return wfExpandUrl( $this->getUrl() ); @@ -456,7 +457,7 @@ abstract class File { /** * Return the file name of a thumbnail with the specified parameters * - * @param array $params Handler-specific parameters + * @param $params Array: handler-specific parameters * @private -ish */ function thumbName( $params ) { @@ -484,8 +485,8 @@ abstract class File { * specified, the generated image will be no bigger than width x height, * and will also have correct aspect ratio. * - * @param integer $width maximum width of the generated thumbnail - * @param integer $height maximum height of the image (optional) + * @param $width Integer: maximum width of the generated thumbnail + * @param $height Integer: maximum height of the image (optional) */ public function createThumb( $width, $height = -1 ) { $params = array( 'width' => $width ); @@ -504,9 +505,9 @@ abstract class File { * * For non-image formats, this may return a filetype-specific icon. * - * @param integer $width maximum width of the generated thumbnail - * @param integer $height maximum height of the image (optional) - * @param boolean $render Deprecated + * @param $width Integer: maximum width of the generated thumbnail + * @param $height Integer: maximum height of the image (optional) + * @param $render Integer: Deprecated * * @return ThumbnailImage or null on failure * @@ -523,9 +524,9 @@ abstract class File { /** * Transform a media file * - * @param array $params An associative array of handler-specific parameters. Typical - * keys are width, height and page. - * @param integer $flags A bitfield, may contain self::RENDER_NOW to force rendering + * @param $params Array: an associative array of handler-specific parameters. + * Typical keys are width, height and page. + * @param $flags Integer: a bitfield, may contain self::RENDER_NOW to force rendering * @return MediaTransformOutput */ function transform( $params, $flags = 0 ) { @@ -849,8 +850,8 @@ abstract class File { * The archive name should be passed through to recordUpload for database * registration. * - * @param string $sourcePath Local filesystem path to the source image - * @param integer $flags A bitwise combination of: + * @param $sourcePath String: local filesystem path to the source image + * @param $flags Integer: a bitwise combination of: * File::DELETE_SOURCE Delete the source file, i.e. move * rather than copy * @return The archive name on success or an empty string if it was a new @@ -992,8 +993,8 @@ abstract class File { * * Cache purging is done; logging is caller's responsibility. * - * @param $reason - * @param $suppress, hide content from sysops? + * @param $reason String + * @param $suppress Boolean: hide content from sysops? * @return true on success, false on some kind of failure * STUB * Overridden by LocalFile @@ -1010,7 +1011,7 @@ abstract class File { * * @param $versions set of record ids of deleted items to restore, * or empty to restore all revisions. - * @param $unsuppress, remove restrictions on content upon restoration? + * @param $unsuppress remove restrictions on content upon restoration? * @return the number of file revisions restored if successful, * or false on failure * STUB @@ -1062,8 +1063,8 @@ abstract class File { * Get an image size array like that returned by getimagesize(), or false if it * can't be determined. * - * @param string $fileName The filename - * @return array + * @param $fileName String: The filename + * @return Array */ function getImageSize( $fileName ) { if ( !$this->getHandler() ) { @@ -1156,8 +1157,8 @@ abstract class File { * Determine if the current user is allowed to view a particular * field of this file, if it's marked as deleted. * STUB - * @param int $field - * @return bool + * @param $field Integer + * @return Boolean */ function userCan( $field ) { return true; @@ -1166,9 +1167,9 @@ abstract class File { /** * Get an associative array containing information about a file in the local filesystem. * - * @param string $path Absolute local filesystem path - * @param mixed $ext The file extension, or true to extract it from the filename. - * Set it to false to ignore the extension. + * @param $path String: absolute local filesystem path + * @param $ext Mixed: the file extension, or true to extract it from the filename. + * Set it to false to ignore the extension. */ static function getPropsFromPath( $path, $ext = true ) { wfProfileIn( __METHOD__ ); diff --git a/includes/filerepo/LocalFile.php b/includes/filerepo/LocalFile.php index b6b4bfed2b..b17214ee39 100644 --- a/includes/filerepo/LocalFile.php +++ b/includes/filerepo/LocalFile.php @@ -739,13 +739,14 @@ class LocalFile extends File { /** * Upload a file and record it in the DB - * @param string $srcPath Source path or virtual URL - * @param string $comment Upload description - * @param string $pageText Text to use for the new description page, if a new description page is created - * @param integer $flags Flags for publish() - * @param array $props File properties, if known. This can be used to reduce the - * upload time when uploading virtual URLs for which the file info - * is already known + * @param $srcPath String: source path or virtual URL + * @param $comment String: upload description + * @param $pageText String: text to use for the new description page, + * if a new description page is created + * @param $flags Integer: flags for publish() + * @param $props Array: File properties, if known. This can be used to reduce the + * upload time when uploading virtual URLs for which the file info + * is already known * @param string $timestamp Timestamp for img_timestamp, or false to use the current time * * @return FileRepoStatus object. On success, the value member contains the @@ -953,8 +954,8 @@ class LocalFile extends File { * The archive name should be passed through to recordUpload for database * registration. * - * @param string $sourcePath Local filesystem path to the source image - * @param integer $flags A bitwise combination of: + * @param $sourcePath String: local filesystem path to the source image + * @param $flags Integer: a bitwise combination of: * File::DELETE_SOURCE Delete the source file, i.e. move * rather than copy * @return FileRepoStatus object. On success, the value member contains the @@ -1064,8 +1065,9 @@ class LocalFile extends File { * * Cache purging is done; logging is caller's responsibility. * - * @param $reason - * @param $suppress + * @param $archiveName String + * @param $reason String + * @param $suppress Boolean * @throws MWException or FSException on database or file store failure * @return FileRepoStatus object. */ @@ -1090,7 +1092,7 @@ class LocalFile extends File { * * @param $versions set of record ids of deleted items to restore, * or empty to restore all revisions. - * @param $unuppress + * @param $unsuppress Boolean * @return FileRepoStatus */ function restore( $versions = array(), $unsuppress = false ) { diff --git a/includes/filerepo/OldLocalFile.php b/includes/filerepo/OldLocalFile.php index 35f3f9f2de..6a245c29c0 100644 --- a/includes/filerepo/OldLocalFile.php +++ b/includes/filerepo/OldLocalFile.php @@ -70,10 +70,10 @@ class OldLocalFile extends LocalFile { } /** - * @param Title $title - * @param FileRepo $repo - * @param string $time Timestamp or null to load by archive name - * @param string $archiveName Archive name or null to load by timestamp + * @param $title Title + * @param $repo FileRepo + * @param $time String: timestamp or null to load by archive name + * @param $archiveNameString: archive name or null to load by timestamp */ function __construct( $title, $repo, $time, $archiveName ) { parent::__construct( $title, $repo ); @@ -172,8 +172,8 @@ class OldLocalFile extends LocalFile { } /** - * int $field one of DELETED_* bitfield constants - * for file or revision rows + * @param $field Integer: one of DELETED_* bitfield constants + * for file or revision rows * @return bool */ function isDeleted( $field ) { @@ -193,7 +193,8 @@ class OldLocalFile extends LocalFile { /** * Determine if the current user is allowed to view a particular * field of this image file, if it's marked as deleted. - * @param int $field + * + * @param $field Integer * @return bool */ function userCan( $field ) { -- 2.20.1