Doxygen documentation update: * Changed alls @addtogroup to @ingroup. @addtogroup adds the comment to the group description, but doesn't add the file, class, function, ... to the group like @ingroup does. See for example http://svn.wikimedia.org/doc/group__SpecialPage.html where it's impossible to see related files, classes, ... that should belong to that group. * Added @file to file description, it seems that it should be explicitely decalred for file descriptions, otherwise doxygen will think that the comment document the first class, variabled, function, ... that is in that file. * Removed some empty comments * Removed some ?> Added following groups: * ExternalStorage * JobQueue * MaintenanceLanguage One more thing: there are still a lot of warnings when generating the doc.
30 lines
697 B
PHP
30 lines
697 B
PHP
<?php
|
|
|
|
/**
|
|
* Generic operation result class for FileRepo-related operations
|
|
* @ingroup FileRepo
|
|
*/
|
|
class FileRepoStatus extends Status {
|
|
/**
|
|
* Factory function for fatal errors
|
|
*/
|
|
static function newFatal( $repo /*, parameters...*/ ) {
|
|
$params = array_slice( func_get_args(), 1 );
|
|
$result = new self( $repo );
|
|
call_user_func_array( array( &$result, 'error' ), $params );
|
|
$result->ok = false;
|
|
return $result;
|
|
}
|
|
|
|
static function newGood( $repo = false, $value = null ) {
|
|
$result = new self( $repo );
|
|
$result->value = $value;
|
|
return $result;
|
|
}
|
|
|
|
function __construct( $repo = false ) {
|
|
if ( $repo ) {
|
|
$this->cleanCallback = $repo->getErrorCleanupFunction();
|
|
}
|
|
}
|
|
}
|