Added a pile of missing docs and fixed a few incorrect ones

Change-Id: Ie134684e2bac9de25e13ead8c2e1a107b5b32168

diff --git a/includes/content/AbstractContent.php b/includes/content/AbstractContent.php
index 860b4c3..488c4be 100644 (file)
--- a/includes/content/AbstractContent.php
+++ b/includes/content/AbstractContent.php
@@ -11,19 +11,25 @@ abstract class AbstractContent implements Content {
         * Name of the content model this Content object represents.
         * Use with CONTENT_MODEL_XXX constants
         *
+        * @since 1.21
+        *
         * @var string $model_id
         */
        protected $model_id;
 
        /**
-        * @param String $model_id
+        * @param string|null $modelId
+        *
+        * @since 1.21
         */
-       public function __construct( $model_id = null ) {
-               $this->model_id = $model_id;
+       public function __construct( $modelId = null ) {
+               $this->model_id = $modelId;
        }
 
        /**
-        * @see Content::getModel()
+        * @see Content::getModel
+        *
+        * @since 1.21
         */
        public function getModel() {
                return $this->model_id;
@@ -33,41 +39,57 @@ abstract class AbstractContent implements Content {
         * Throws an MWException if $model_id is not the id of the content model
         * supported by this Content object.
         *
-        * @param $model_id int the model to check
+        * @since 1.21
+        *
+        * @param string $modelId The model to check
         *
         * @throws MWException
         */
-       protected function checkModelID( $model_id ) {
-               if ( $model_id !== $this->model_id ) {
-                       throw new MWException( "Bad content model: " .
+       protected function checkModelID( $modelId ) {
+               if ( $modelId !== $this->model_id ) {
+                       throw new MWException(
+                               "Bad content model: " .
                                "expected {$this->model_id}  " .
-                               "but got $model_id." );
+                               "but got $modelId."
+                       );
                }
        }
 
        /**
-        * @see Content::getContentHandler()
+        * @see Content::getContentHandler
+        *
+        * @since 1.21
         */
        public function getContentHandler() {
                return ContentHandler::getForContent( $this );
        }
 
        /**
-        * @see Content::getDefaultFormat()
+        * @see Content::getDefaultFormat
+        *
+        * @since 1.21
         */
        public function getDefaultFormat() {
                return $this->getContentHandler()->getDefaultFormat();
        }
 
        /**
-        * @see Content::getSupportedFormats()
+        * @see Content::getSupportedFormats
+        *
+        * @since 1.21
         */
        public function getSupportedFormats() {
                return $this->getContentHandler()->getSupportedFormats();
        }
 
        /**
-        * @see Content::isSupportedFormat()
+        * @see Content::isSupportedFormat
+        *
+        * @param string $format
+        *
+        * @since 1.21
+        *
+        * @return boolean
         */
        public function isSupportedFormat( $format ) {
                if ( !$format ) {
@@ -78,42 +100,66 @@ abstract class AbstractContent implements Content {
        }
 
        /**
-        * Throws an MWException if $this->isSupportedFormat( $format ) doesn't
+        * Throws an MWException if $this->isSupportedFormat( $format ) does not
         * return true.
         *
-        * @param $format
+        * @since 1.21
+        *
+        * @param string $format
         * @throws MWException
         */
        protected function checkFormat( $format ) {
                if ( !$this->isSupportedFormat( $format ) ) {
-                       throw new MWException( "Format $format is not supported for content model " .
-                               $this->getModel() );
+                       throw new MWException(
+                               "Format $format is not supported for content model " .
+                               $this->getModel()
+                       );
                }
        }
 
        /**
         * @see Content::serialize
+        *
+        * @param string|null $format
+        *
+        * @since 1.21
+        *
+        * @return string
         */
        public function serialize( $format = null ) {
                return $this->getContentHandler()->serializeContent( $this, $format );
        }
 
        /**
-        * @see Content::isEmpty()
+        * @see Content::isEmpty
+        *
+        * @since 1.21
+        *
+        * @return boolean
         */
        public function isEmpty() {
                return $this->getSize() === 0;
        }
 
        /**
-        * @see Content::isValid()
+        * @see Content::isValid
+        *
+        * @since 1.21
+        *
+        * @return boolean
         */
        public function isValid() {
                return true;
        }
 
        /**
-        * @see Content::equals()
+        * @see Content::equals
+        *
+        * @since 1.21
+        *
+        * @param Content|null $that
+        *
+        * @return boolean
         */
        public function equals( Content $that = null ) {
                if ( is_null( $that ) ) {
@@ -173,7 +219,9 @@ abstract class AbstractContent implements Content {
 
 
        /**
-        * @see Content::getRedirectChain()
+        * @see Content::getRedirectChain
+        *
+        * @since 1.21
         */
        public function getRedirectChain() {
                global $wgMaxRedirects;
@@ -205,15 +253,19 @@ abstract class AbstractContent implements Content {
        }
 
        /**
-        * @see Content::getRedirectTarget()
+        * @see Content::getRedirectTarget
+        *
+        * @since 1.21
         */
        public function getRedirectTarget() {
                return null;
        }
 
        /**
-        * @see Content::getUltimateRedirectTarget()
+        * @see Content::getUltimateRedirectTarget
         * @note: migrated here from Title::newFromRedirectRecurse
+        *
+        * @since 1.21
         */
        public function getUltimateRedirectTarget() {
                $titles = $this->getRedirectChain();
@@ -221,7 +273,7 @@ abstract class AbstractContent implements Content {
        }
 
        /**
-        * @see Content::isRedirect()
+        * @see Content::isRedirect
         *
         * @since 1.21
         *
@@ -232,10 +284,12 @@ abstract class AbstractContent implements Content {
        }
 
        /**
-        * @see Content::updateRedirect()
+        * @see Content::updateRedirect
         *
         * This default implementation always returns $this.
         *
+        * @param Title $target
+        *
         * @since 1.21
         *
         * @return Content $this
@@ -245,42 +299,54 @@ abstract class AbstractContent implements Content {
        }
 
        /**
-        * @see Content::getSection()
+        * @see Content::getSection
+        *
+        * @since 1.21
         */
        public function getSection( $sectionId ) {
                return null;
        }
 
        /**
-        * @see Content::replaceSection()
+        * @see Content::replaceSection
+        *
+        * @since 1.21
         */
        public function replaceSection( $section, Content $with, $sectionTitle = ''  ) {
                return null;
        }
 
        /**
-        * @see Content::preSaveTransform()
+        * @see Content::preSaveTransform
+        *
+        * @since 1.21
         */
        public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
                return $this;
        }
 
        /**
-        * @see Content::addSectionHeader()
+        * @see Content::addSectionHeader
+        *
+        * @since 1.21
         */
        public function addSectionHeader( $header ) {
                return $this;
        }
 
        /**
-        * @see Content::preloadTransform()
+        * @see Content::preloadTransform
+        *
+        * @since 1.21
         */
        public function preloadTransform( Title $title, ParserOptions $popts ) {
                return $this;
        }
 
        /**
-        * @see  Content::prepareSave()
+        * @see Content::prepareSave
+        *
+        * @since 1.21
         */
        public function prepareSave( WikiPage $page, $flags, $baseRevId, User $user ) {
                if ( $this->isValid() ) {
@@ -291,7 +357,7 @@ abstract class AbstractContent implements Content {
        }
 
        /**
-        * @see  Content::getDeletionUpdates()
+        * @see Content::getDeletionUpdates
         *
         * @since 1.21
         *
@@ -312,10 +378,12 @@ abstract class AbstractContent implements Content {
        }
 
        /**
-        * @see  Content::matchMagicWord()
-        *
         * This default implementation always returns false. Subclasses may override this to supply matching logic.
         *
+        * @see Content::matchMagicWord
+        *
+        * @since 1.21
+        *
         * @param MagicWord $word
         *
         * @return bool

diff --git a/includes/content/Content.php b/includes/content/Content.php
index 6cb9d89..1745ae2 100644 (file)
--- a/includes/content/Content.php
+++ b/includes/content/Content.php
@@ -17,7 +17,7 @@ interface Content {
         * @todo: test that this actually works
         * @todo: make sure this also works with LuceneSearch / WikiSearch
         */
-       public function getTextForSearchIndex( );
+       public function getTextForSearchIndex();
 
        /**
         * @since 1.21
@@ -31,7 +31,7 @@ interface Content {
         * @TODO: used in WikiPage and MessageCache to get message text. Not so
         *    nice. What should we use instead?!
         */
-       public function getWikitextForTransclusion( );
+       public function getWikitextForTransclusion();
 
        /**
         * Returns a textual representation of the content suitable for use in edit
@@ -39,10 +39,10 @@ interface Content {
         *
         * @since 1.21
         *
-        * @param $maxlength int Maximum length of the summary text
-        * @return   The summary text
+        * @param $maxLength int Maximum length of the summary text
+        * @return string The summary text
         */
-       public function getTextForSummary( $maxlength = 250 );
+       public function getTextForSummary( $maxLength = 250 );
 
        /**
         * Returns native representation of the data. Interpretation depends on
@@ -56,14 +56,14 @@ interface Content {
         *
         * @NOTE: Caller must be aware of content model!
         */
-       public function getNativeData( );
+       public function getNativeData();
 
        /**
         * Returns the content's nominal size in bogo-bytes.
         *
         * @return int
         */
-       public function getSize( );
+       public function getSize();
 
        /**
         * Returns the ID of the content model used by this Content object.
@@ -418,6 +418,8 @@ interface Content {
         * Note that this method is called before any update to the page table is performed. This means that
         * $page may not yet know a page ID.
         *
+        * @since 1.21
+        *
         * @param WikiPage $page The page to be saved.
         * @param int      $flags bitfield for use with EDIT_XXX constants, see WikiPage::doEditContent()
         * @param int      $baseRevId the ID of the current revision
@@ -452,6 +454,8 @@ interface Content {
        /**
         * Returns true if this Content object matches the given magic word.
         *
+        * @since 1.21
+        *
         * @param MagicWord $word the magic word to match
         *
         * @return bool whether this Content object matches the given magic word.