Add/update/improve various bits of documentation

This commit is contained in:
Sam Reed 2011-03-25 11:21:53 +00:00
parent 757750dcac
commit d3f043c53a
4 changed files with 29 additions and 4 deletions

View file

@ -3369,7 +3369,7 @@ function wfArrayMap( $function, $input ) {
/**
* Get a cache object.
* @param $inputType Cache type, one the the CACHE_* constants.
* @param integer $inputType Cache type, one the the CACHE_* constants.
*
* @return BagOStuff
*/

View file

@ -18,7 +18,14 @@
class UploadFromUrlJob extends Job {
const SESSION_KEYNAME = 'wsUploadFromUrlJobData';
/**
* @var UploadFromUrl
*/
public $upload;
/**
* @var User
*/
protected $user;
public function __construct( $title, $params, $id = 0 ) {

View file

@ -630,9 +630,23 @@ class SearchResultTooMany {
* @ingroup Search
*/
class SearchResult {
/**
* @var Revision
*/
var $mRevision = null;
var $mImage = null;
/**
* @var Title
*/
var $mTitle;
/**
* @var String
*/
var $mText;
/**
* Return a new SearchResult and initializes it with a title.
*

View file

@ -16,8 +16,12 @@ class UploadStash {
// Format of the key for files -- has to be suitable as a filename itself (e.g. ab12cd34ef.jpg)
const KEY_FORMAT_REGEX = '/^[\w-]+\.\w+$/';
// repository that this uses to store temp files
// public because we sometimes need to get a LocalFile within the same repo.
/**
* repository that this uses to store temp files
* public because we sometimes need to get a LocalFile within the same repo.
*
* @var LocalRepo
*/
public $repo;
// array of initialized objects obtained from session (lazily initialized upon getFile())
@ -235,7 +239,7 @@ class UploadStashFile extends UnregisteredLocalFile {
* Arguably UnregisteredLocalFile should be handling its own file repo but that class is a bit retarded currently
*
* @param $stash UploadStash: useful for obtaining config, stashing transformed files
* @param $repo FileRepo: repository where we should find the path
* @param $repo FSRepo: repository where we should find the path
* @param $path String: path to file
* @param $key String: key to store the path and any stashed data under
* @param $data String: any other data we want stored with this file