(bug 25832) query=allimages now outputs ns/title as well

[lhc/web/wiklou.git] / includes / api / ApiFormatYaml.php

diff --git a/includes/api/ApiFormatYaml.php b/includes/api/ApiFormatYaml.php
index adb23cd..58153fa 100644 (file)
--- a/includes/api/ApiFormatYaml.php
+++ b/includes/api/ApiFormatYaml.php
@@ -1,12 +1,10 @@
 <?php
-
-
-/*
- * Created on Sep 19, 2006
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Created on Sep 19, 2006
+ *
+ * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -20,19 +18,25 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ('ApiFormatBase.php');
+       require_once( 'ApiFormatBase.php' );
 }
 
+/**
+ * API YAML output formatter
+ * @ingroup API
+ */
 class ApiFormatYaml extends ApiFormatBase {
 
-       public function __construct($main, $format) {
-               parent :: __construct($main, $format);
+       public function __construct( $main, $format ) {
+               parent::__construct( $main, $format );
        }
 
        public function getMimeType() {
@@ -40,15 +44,14 @@ class ApiFormatYaml extends ApiFormatBase {
        }
 
        public function execute() {
-               $this->printText(Spyc :: YAMLDump($this->getResultData()));
+               $this->printText( Spyc::YAMLDump( $this->getResultData() ) );
        }
 
-       protected function getDescription() {
-               return 'Output data in YAML format';
+       public function getDescription() {
+               return 'Output data in YAML format' . parent::getDescription();
        }
 
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
 }
-?>
\ No newline at end of file