diff options
Diffstat (limited to 'includes/api')
27 files changed, 117 insertions, 61 deletions
diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index a29e3360cc82..a8b1939958f0 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 5, 2006 * @@ -26,6 +25,7 @@ /** * @todo Document - e.g. Provide top-level description of this class. + * @addtogroup API */ abstract class ApiBase { @@ -533,4 +533,4 @@ abstract class ApiBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFeedWatchlist.php b/includes/api/ApiFeedWatchlist.php index 335df324b7f8..97d1f7989791 100644 --- a/includes/api/ApiFeedWatchlist.php +++ b/includes/api/ApiFeedWatchlist.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 13, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ("ApiBase.php"); } +/** + * @addtogroup API + */ class ApiFeedWatchlist extends ApiBase { public function __construct($main, $action) { diff --git a/includes/api/ApiFormatBase.php b/includes/api/ApiFormatBase.php index 1ed71a6f914f..082433887fbf 100644 --- a/includes/api/ApiFormatBase.php +++ b/includes/api/ApiFormatBase.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ abstract class ApiFormatBase extends ApiBase { private $mIsHtml, $mFormat; @@ -176,6 +178,7 @@ for more information. /** * This printer is used to wrap an instance of the Feed class + * @addtogroup API */ class ApiFormatFeedWrapper extends ApiFormatBase { diff --git a/includes/api/ApiFormatJson.php b/includes/api/ApiFormatJson.php index 06dc99bbd68a..99979d207d88 100644 --- a/includes/api/ApiFormatJson.php +++ b/includes/api/ApiFormatJson.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatJson extends ApiFormatBase { private $mIsRaw; @@ -66,4 +68,4 @@ class ApiFormatJson extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatJson_json.php b/includes/api/ApiFormatJson_json.php index c15cdd8003d8..2cd87930b342 100644 --- a/includes/api/ApiFormatJson_json.php +++ b/includes/api/ApiFormatJson_json.php @@ -45,7 +45,7 @@ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH * DAMAGE. * -* @addtogroup Services_JSON +* @addtogroup API * @author Michal Migurski <mike-json@teczno.com> * @author Matt Knapp <mdknapp[at]gmail[dot]com> * @author Brett Stimmerman <brettstimmerman[at]gmail[dot]com> @@ -91,26 +91,28 @@ define('SERVICES_JSON_LOOSE_TYPE', 16); define('SERVICES_JSON_SUPPRESS_ERRORS', 32); /** -* Converts to and from JSON format. -* -* Brief example of use: -* -* <code> -* // create a new instance of Services_JSON -* $json = new Services_JSON(); -* -* // convert a complexe value to JSON notation, and send it to the browser -* $value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4))); -* $output = $json->encode($value); -* -* print($output); -* // prints: ["foo","bar",[1,2,"baz"],[3,[4]]] -* -* // accept incoming POST data, assumed to be in JSON notation -* $input = file_get_contents('php://input', 1000000); -* $value = $json->decode($input); -* </code> -*/ + * Converts to and from JSON format. + * + * Brief example of use: + * + * <code> + * // create a new instance of Services_JSON + * $json = new Services_JSON(); + * + * // convert a complexe value to JSON notation, and send it to the browser + * $value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4))); + * $output = $json->encode($value); + * + * print($output); + * // prints: ["foo","bar",[1,2,"baz"],[3,[4]]] + * + * // accept incoming POST data, assumed to be in JSON notation + * $input = file_get_contents('php://input', 1000000); + * $value = $json->decode($input); + * </code> + * + * @addtogroup API + */ class Services_JSON { /** @@ -812,6 +814,9 @@ class Services_JSON if (class_exists('PEAR_Error')) { + /** + * @addtogroup API + */ class Services_JSON_Error extends PEAR_Error { function Services_JSON_Error($message = 'unknown error', $code = null, @@ -825,6 +830,7 @@ if (class_exists('PEAR_Error')) { /** * @todo Ultimately, this class shall be descended from PEAR_Error + * @addtogroup API */ class Services_JSON_Error { diff --git a/includes/api/ApiFormatPhp.php b/includes/api/ApiFormatPhp.php index f635f4ca797a..20480b6df49f 100644 --- a/includes/api/ApiFormatPhp.php +++ b/includes/api/ApiFormatPhp.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 22, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatPhp extends ApiFormatBase { public function __construct($main, $format) { @@ -51,4 +53,4 @@ class ApiFormatPhp extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatWddx.php b/includes/api/ApiFormatWddx.php index 71f13d4a3ae4..ad902b630cbb 100644 --- a/includes/api/ApiFormatWddx.php +++ b/includes/api/ApiFormatWddx.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 22, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatWddx extends ApiFormatBase { public function __construct($main, $format) { @@ -86,4 +88,4 @@ class ApiFormatWddx extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatXml.php b/includes/api/ApiFormatXml.php index 5d4e776f4a34..0c81c2fc9c68 100644 --- a/includes/api/ApiFormatXml.php +++ b/includes/api/ApiFormatXml.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatXml extends ApiFormatBase { private $mRootElemName = 'api'; @@ -142,4 +144,4 @@ class ApiFormatXml extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatYaml.php b/includes/api/ApiFormatYaml.php index 006e9733a035..5fc89b9a4061 100644 --- a/includes/api/ApiFormatYaml.php +++ b/includes/api/ApiFormatYaml.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatYaml extends ApiFormatBase { public function __construct($main, $format) { @@ -51,4 +53,4 @@ class ApiFormatYaml extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatYaml_spyc.php b/includes/api/ApiFormatYaml_spyc.php index 91155aa99cad..a67bbb22aad0 100644 --- a/includes/api/ApiFormatYaml_spyc.php +++ b/includes/api/ApiFormatYaml_spyc.php @@ -6,12 +6,11 @@ * @see http://spyc.sourceforge.net/ * @copyright Copyright 2005-2006 Chris Wanstrath * @license http://www.opensource.org/licenses/mit-license.php MIT License - * @addtogroup Spyc */ /** * A node, used by Spyc for parsing YAML. - * @addtogroup Spyc + * @addtogroup API */ class YAMLNode { /**#@+ @@ -59,7 +58,7 @@ * $parser = new Spyc; * $array = $parser->load($file); * </code> - * @addtogroup Spyc + * @addtogroup API */ class Spyc { diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php index 07108ced2541..570c7874d45c 100644 --- a/includes/api/ApiHelp.php +++ b/includes/api/ApiHelp.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 6, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ class ApiHelp extends ApiBase { public function __construct($main, $action) { @@ -52,4 +54,4 @@ class ApiHelp extends ApiBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiLogin.php b/includes/api/ApiLogin.php index 954cd1974d15..9a8c70ee1805 100644 --- a/includes/api/ApiLogin.php +++ b/includes/api/ApiLogin.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ class ApiLogin extends ApiBase { public function __construct($main, $action) { diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php index 214cfc747d12..c4d5a8393047 100644 --- a/includes/api/ApiMain.php +++ b/includes/api/ApiMain.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 4, 2006 * @@ -31,6 +30,7 @@ if (!defined('MEDIAWIKI')) { /** * This is the main API class, used for both external and internal processing. + * @addtogroup API */ class ApiMain extends ApiBase { @@ -347,6 +347,7 @@ class ApiMain extends ApiBase { /** * This exception will be thrown when dieUsage is called to stop module execution. + * @addtogroup API */ class UsageException extends Exception { diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php index 3bbcf4e24dcf..48d6b1373c59 100644 --- a/includes/api/ApiOpenSearch.php +++ b/includes/api/ApiOpenSearch.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 13, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ("ApiBase.php"); } +/** + * @addtogroup API + */ class ApiOpenSearch extends ApiBase { public function __construct($main, $action) { @@ -106,4 +108,4 @@ class ApiOpenSearch extends ApiBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php index 1b555673bff9..a99ec218e2fe 100644 --- a/includes/api/ApiPageSet.php +++ b/includes/api/ApiPageSet.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 24, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiPageSet extends ApiQueryBase { private $mAllPages; // [ns][dbkey] => page_id or 0 when missing diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index 72859d89975e..a42dec23498a 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 7, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ class ApiQuery extends ApiBase { private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames; diff --git a/includes/api/ApiQueryAllpages.php b/includes/api/ApiQueryAllpages.php index df137d39ce5e..02f5e116f7ac 100644 --- a/includes/api/ApiQueryAllpages.php +++ b/includes/api/ApiQueryAllpages.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 25, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryAllpages extends ApiQueryGeneratorBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQueryBacklinks.php b/includes/api/ApiQueryBacklinks.php index a799c7d74f15..677ead47802a 100644 --- a/includes/api/ApiQueryBacklinks.php +++ b/includes/api/ApiQueryBacklinks.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 16, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ("ApiQueryBase.php"); } +/** + * @addtogroup API + */ class ApiQueryBacklinks extends ApiQueryGeneratorBase { private $rootTitle, $contRedirs, $contLevel, $contTitle, $contID; @@ -355,4 +357,4 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiQueryBase.php b/includes/api/ApiQueryBase.php index cc9a4fed7a85..bc8c483f7432 100644 --- a/includes/api/ApiQueryBase.php +++ b/includes/api/ApiQueryBase.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 7, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ abstract class ApiQueryBase extends ApiBase { private $mQueryModule, $tables, $where, $fields, $options; @@ -341,6 +343,9 @@ abstract class ApiQueryBase extends ApiBase { } } +/** + * @addtogroup API + */ abstract class ApiQueryGeneratorBase extends ApiQueryBase { private $mIsGenerator; diff --git a/includes/api/ApiQueryInfo.php b/includes/api/ApiQueryInfo.php index 07928b501296..3014fec12daa 100644 --- a/includes/api/ApiQueryInfo.php +++ b/includes/api/ApiQueryInfo.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 25, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryInfo extends ApiQueryBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQueryLogEvents.php b/includes/api/ApiQueryLogEvents.php index 73e0c8452f6b..3142c9e0966d 100644 --- a/includes/api/ApiQueryLogEvents.php +++ b/includes/api/ApiQueryLogEvents.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 16, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryLogEvents extends ApiQueryBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQueryRecentChanges.php b/includes/api/ApiQueryRecentChanges.php index b1cf4102f87c..cec0fb5e4621 100644 --- a/includes/api/ApiQueryRecentChanges.php +++ b/includes/api/ApiQueryRecentChanges.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryRecentChanges extends ApiQueryBase { public function __construct($query, $moduleName) { @@ -184,4 +186,4 @@ class ApiQueryRecentChanges extends ApiQueryBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiQueryRevisions.php b/includes/api/ApiQueryRevisions.php index d2c043611ac4..c07b938cf607 100644 --- a/includes/api/ApiQueryRevisions.php +++ b/includes/api/ApiQueryRevisions.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 7, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryRevisions extends ApiQueryBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQuerySiteinfo.php b/includes/api/ApiQuerySiteinfo.php index ea9601f770d6..f174782c1646 100644 --- a/includes/api/ApiQuerySiteinfo.php +++ b/includes/api/ApiQuerySiteinfo.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 25, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQuerySiteinfo extends ApiQueryBase { public function __construct($query, $moduleName) { @@ -113,4 +115,4 @@ class ApiQuerySiteinfo extends ApiQueryBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiQueryUserContributions.php b/includes/api/ApiQueryUserContributions.php index d518e889d9ac..6f99b9d42e6d 100644 --- a/includes/api/ApiQueryUserContributions.php +++ b/includes/api/ApiQueryUserContributions.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 16, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryContributions extends ApiQueryBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQueryWatchlist.php b/includes/api/ApiQueryWatchlist.php index e2557e95fe70..99e7151efcff 100644 --- a/includes/api/ApiQueryWatchlist.php +++ b/includes/api/ApiQueryWatchlist.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 25, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryWatchlist extends ApiQueryGeneratorBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiResult.php b/includes/api/ApiResult.php index b56d7ac65807..65f17e8b4102 100644 --- a/includes/api/ApiResult.php +++ b/includes/api/ApiResult.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 4, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ class ApiResult extends ApiBase { private $mData, $mIsRawMode; @@ -154,4 +156,4 @@ class ApiResult extends ApiBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> |