http://www.mediawiki.org/wiki/Special:Code/MediaWiki/90865
Revision: 90865
Author: happy-melon
Date: 2011-06-26 23:40:43 +0000 (Sun, 26 Jun 2011)
Log Message:
-----------
Follow-up r86234, and more parameter documentation.
Modified Paths:
--------------
trunk/phase3/includes/Skin.php
Modified: trunk/phase3/includes/Skin.php
===================================================================
--- trunk/phase3/includes/Skin.php 2011-06-26 23:39:06 UTC (rev 90864)
+++ trunk/phase3/includes/Skin.php 2011-06-26 23:40:43 UTC (rev 90865)
@@ -282,6 +282,8 @@
* as their "relevant" title, this allows the skin system to display
things
* such as content tabs which belong to to that page instead of
displaying
* a basic special page tab which has almost no meaning.
+ *
+ * @return Title
*/
public function getRelevantTitle() {
if ( isset($this->mRelevantTitle) ) {
@@ -329,7 +331,7 @@
/**
* Outputs the HTML generated by other functions.
- * @param $out Object: instance of OutputPage
+ * @param $out OutputPage
*/
abstract function outputPage( OutputPage $out );
@@ -398,6 +400,8 @@
/**
* @private
+ * @todo document
+ * @param $out OutputPage
*/
function setupUserCss( OutputPage $out ) {
global $wgUseSiteCss, $wgAllowUserCss, $wgAllowUserCssPrefs;
@@ -495,6 +499,8 @@
* This will be called by OutputPage::headElement when it is creating
the
* <body> tag, skins can override it if they have a need to add in any
* body attributes or classes of their own.
+ * @param $out OutputPage
+ * @param $bodyAttrs Array
*/
function addToBodyAttributes( $out, &$bodyAttrs ) {
// does nothing by default
@@ -502,6 +508,7 @@
/**
* URL to the logo
+ * @return String
*/
function getLogo() {
global $wgLogo;
@@ -564,7 +571,7 @@
$parenttree =
$this->getTitle()->getParentCategoryTree();
# Skin object passed by reference cause it can not be
# accessed under the method subfunction
drawCategoryBrowser
- $tempout = explode( "\n", $this->drawCategoryBrowser(
$parenttree, $this ) );
+ $tempout = explode( "\n", $this->drawCategoryBrowser(
$parenttree ) );
# Clean out bogus first entry and sort them
unset( $tempout[0] );
asort( $tempout );
@@ -631,7 +638,7 @@
* The output of this function gets processed in
SkinTemplate::outputPage() for
* the SkinTemplate based skins, all other skins should directly echo
it.
*
- * Returns an empty string by default, if not changed by any hook
function.
+ * @return String, empty by default, if not changed by any hook
function.
*/
protected function afterContentHook() {
$data = '';
@@ -826,6 +833,7 @@
/**
* Returns true if the IP should be shown in the header
+ * @return Bool
*/
function showIPinHeader() {
global $wgShowIPinHeader;
@@ -975,7 +983,8 @@
/**
* Renders a $wgFooterIcons icon acording to the method's arguments
* @param $icon Array: The icon to build the html for, see
$wgFooterIcons for the format of this array
- * @param $withImage Boolean: Whether to use the icon's image or output
a text-only footericon
+ * @param $withImage Bool|String: Whether to use the icon's image or
output a text-only footericon
+ * @return String HTML
*/
function makeFooterIcon( $icon, $withImage = 'withImage' ) {
if ( is_string( $icon ) ) {
@@ -1031,6 +1040,7 @@
/**
* Gets the link to the wiki's privacy policy page.
+ * @return String HTML
*/
function privacyLink() {
return $this->footerLink( 'privacy', 'privacypage' );
@@ -1038,6 +1048,7 @@
/**
* Gets the link to the wiki's about page.
+ * @return String HTML
*/
function aboutLink() {
return $this->footerLink( 'aboutsite', 'aboutpage' );
@@ -1045,6 +1056,7 @@
/**
* Gets the link to the wiki's general disclaimers page.
+ * @return String HTML
*/
function disclaimerLink() {
return $this->footerLink( 'disclaimers', 'disclaimerpage' );
@@ -1131,6 +1143,8 @@
/**
* If url string starts with http, consider as external URL, else
* internal
+ * @param $name String
+ * @return String URL
*/
static function makeInternalOrExternalUrl( $name ) {
if ( preg_match( '/^(?:' . wfUrlProtocols() . ')/', $name ) ) {
@@ -1161,6 +1175,9 @@
/**
* Make URL details where the article exists (or at least it's
convenient to think so)
+ * @param $name String Article name
+ * @param $urlaction String
+ * @return Array
*/
static function makeKnownUrlDetails( $name, $urlaction = '' ) {
$title = Title::newFromText( $name );
@@ -1230,6 +1247,7 @@
* @since 1.17
* @param &$bar array
* @param $text string
+ * @return Array
*/
function addToSidebarPlain( &$bar, $text ) {
$lines = explode( "\n", $text );
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
