From 7fba23044db8d1216ab251c8eb7ab1517a307e29 Mon Sep 17 00:00:00 2001 From: Aryeh Gregor Date: Fri, 10 Oct 2008 15:37:44 +0000 Subject: [PATCH] Reformat comment for Title::newFromText 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 : "@param varname type desc...". Also respace to 80 chars per line, not some random number. --- includes/Title.php | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/includes/Title.php b/includes/Title.php index 029938b7a2..cbef1ca1c6 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -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 ) ) { -- 2.20.1