Reformat comment for Title::newFromText
authorAryeh Gregor <simetrical@users.mediawiki.org>
Fri, 10 Oct 2008 15:37:44 +0000 (15:37 +0000)
committerAryeh Gregor <simetrical@users.mediawiki.org>
Fri, 10 Oct 2008 15:37:44 +0000 (15:37 +0000)
Don't use ugly \type nonsense.  We want this to be readable in the source code at least as much as in the auto-generated docs.  Follow the standard used everywhere else, documented at <http://www.mediawiki.org/wiki/Manual:Code_standards>: "@param varname type desc...".  Also respace to 80 chars per line, not some random number.

includes/Title.php

index 029938b..cbef1ca 100644 (file)
@@ -94,15 +94,14 @@ class Title {
        }
 
        /**
-        * Create a new Title from text, such as what one would
-        * find in a link. Decodes any HTML entities in the text.
+        * Create a new Title from text, such as what one would find in a link. De-
+        * codes any HTML entities in the text.
         *
-        * @param $text \type{\string} the link text; spaces, prefixes,
-        *      and an initial ':' indicating the main namespace
-        *      are accepted
-        * @param $defaultNamespace \type{\int} the namespace to use if
-        *      none is specified by a prefix
-        * @return \type{Title} the new object, or NULL on an error
+        * @param $text             string  The link text; spaces, prefixes, and an
+        *   initial ':' indicating the main namespace are accepted.
+        * @param $defaultNamespace int     The namespace to use if none is speci-
+        *   fied by a prefix.
+        * @return Title  The new object, or null on an error.
         */
        public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
                if( is_object( $text ) ) {