Merge "Documentation improvements in includes/actions"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Tue, 12 Mar 2013 15:11:12 +0000 (15:11 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Tue, 12 Mar 2013 15:11:12 +0000 (15:11 +0000)
1  2 
includes/actions/CreditsAction.php
includes/actions/HistoryAction.php
includes/actions/InfoAction.php

@@@ -23,6 -23,9 +23,9 @@@
   * @author <evan@wikitravel.org>
   */
  
+ /**
+  * @ingroup Actions
+  */
  class CreditsAction extends FormlessAction {
  
        public function getName() {
@@@ -55,8 -58,8 +58,8 @@@
        /**
         * Get a list of contributors
         *
 -       * @param $cnt Int: maximum list of contributors to show
 -       * @param $showIfMax Bool: whether to contributors if there more than $cnt
 +       * @param int $cnt maximum list of contributors to show
 +       * @param bool $showIfMax whether to contributors if there more than $cnt
         * @return String: html
         */
        public function getCredits( $cnt, $showIfMax = true ) {
  
        /**
         * Get a list of contributors of $article
 -       * @param $cnt Int: maximum list of contributors to show
 -       * @param $showIfMax Bool: whether to contributors if there more than $cnt
 +       * @param int $cnt maximum list of contributors to show
 +       * @param bool $showIfMax whether to contributors if there more than $cnt
         * @return String: html
         */
        protected function getContributors( $cnt, $showIfMax ) {
@@@ -20,6 -20,7 +20,7 @@@
   * http://www.gnu.org/copyleft/gpl.html
   *
   * @file
+  * @ingroup Actions
   */
  
  /**
@@@ -30,6 -31,7 +31,7 @@@
   * Construct it by passing in an Article, and call $h->history() to print the
   * history.
   *
+  * @ingroup Actions
   */
  class HistoryAction extends FormlessAction {
        const DIR_PREV = 0;
                /**
                 * Add date selector to quickly get to a certain time
                 */
 -              $year        = $request->getInt( 'year' );
 -              $month       = $request->getInt( 'month' );
 -              $tagFilter   = $request->getVal( 'tagfilter' );
 +              $year = $request->getInt( 'year' );
 +              $month = $request->getInt( 'month' );
 +              $tagFilter = $request->getVal( 'tagfilter' );
                $tagSelector = ChangeTags::buildTagFilterSelector( $tagFilter );
  
                /**
        /**
         * Output a subscription feed listing recent edits to this page.
         *
 -       * @param $type String: feed type
 +       * @param string $type feed type
         */
        function feed( $type ) {
                global $wgFeedClasses, $wgFeedLimit;
  
  /**
   * @ingroup Pager
+  * @ingroup Actions
   */
  class HistoryPager extends ReverseChronologicalPager {
        public $lastRow = false, $counter, $historyPage, $buttons, $conds;
        /**
         * Creates a submit button
         *
 -       * @param $message String: text of the submit button, will be escaped
 -       * @param $attributes Array: attributes
 +       * @param string $message text of the submit button, will be escaped
 +       * @param array $attributes attributes
         * @return String: HTML output for the submit button
         */
        function submitButton( $message, $attributes = array() ) {
   * @ingroup Actions
   */
  
+ /**
+  * Displays information about a page.
+  *
+  * @ingroup Actions
+  */
  class InfoAction extends FormlessAction {
        /**
         * Returns the name of the action this object responds to.
        /**
         * Adds a row to a table that will be added to the content.
         *
 -       * @param $table string The table that will be added to the content
 -       * @param $name string The name of the row
 -       * @param $value string The value of the row
 +       * @param string $table The table that will be added to the content
 +       * @param string $name The name of the row
 +       * @param string $value The value of the row
         * @return string The table with the row added
         */
        protected function addRow( $table, $name, $value ) {
        /**
         * Adds a table to the content that will be added to the output.
         *
 -       * @param $content string The content that will be added to the output
 -       * @param $table string The table
 +       * @param string $content The content that will be added to the output
 +       * @param string $table The table
         * @return string The content with the table added
         */
        protected function addTable( $content, $table ) {