Phuedx has uploaded a new change for review.
https://gerrit.wikimedia.org/r/169731
Change subject: Fix PHPDoc warnings
......................................................................
Fix PHPDoc warnings
Change-Id: Idf3715538800ea9b85377d0e5048a9290f7ef017
---
M includes/MobileUI.php
M includes/skins/UserLoginAndCreateTemplate.php
M includes/specials/SpecialMobileEditWatchlist.php
3 files changed, 34 insertions(+), 6 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MobileFrontend
refs/changes/31/169731/1
diff --git a/includes/MobileUI.php b/includes/MobileUI.php
index cf368d9..8182621 100644
--- a/includes/MobileUI.php
+++ b/includes/MobileUI.php
@@ -1,6 +1,13 @@
<?php
+/**
+ * MobileUI.php
+ */
+
// FIXME: Use OOUI PHP when available.
+/**
+ * Helper methods for generating parts of the UI.
+ */
class MobileUI {
/**
diff --git a/includes/skins/UserLoginAndCreateTemplate.php
b/includes/skins/UserLoginAndCreateTemplate.php
index e2c9c8c..9adc694 100644
--- a/includes/skins/UserLoginAndCreateTemplate.php
+++ b/includes/skins/UserLoginAndCreateTemplate.php
@@ -47,6 +47,8 @@
/**
* Render message box with system messages, e.g. errors or already
logged-in notices
+ *
+ * @param bool $register Whether the user can register an account
*/
protected function renderMessageHtml( $register = false ) {
$msgBox = ''; // placeholder for displaying any login-related
system messages (eg errors)
diff --git a/includes/specials/SpecialMobileEditWatchlist.php
b/includes/specials/SpecialMobileEditWatchlist.php
index 4b5c93d..118251c 100644
--- a/includes/specials/SpecialMobileEditWatchlist.php
+++ b/includes/specials/SpecialMobileEditWatchlist.php
@@ -1,18 +1,28 @@
<?php
+
/**
- * Represents a mobile version of Special:EditWatchlist
+ * SpecialMobileEditWatchlist.php
*/
+/**
+ * The mobile version of the watchlist editing page.
+ */
class SpecialMobileEditWatchlist extends SpecialEditWatchlist {
+
+ /**
+ * Renders the subheader.
+ */
protected function outputSubtitle() {
$user = $this->getUser();
$this->getOutput()->addHtml(
SpecialMobileWatchlist::getWatchlistHeader( $user ) );
}
/**
- * @param Title $title
- * @param int $ts
- * @param string $thumb
+ * Gets the HTML fragment for a watched page.
+ *
+ * @param Title $title The title of the watched page
+ * @param int $ts When the page was last touched
+ * @param string $thumb An HTML fragment for the page's thumbnaiL
* @return string
*/
public static function getLineHtml( Title $title, $ts, $thumb ) {
@@ -48,17 +58,26 @@
return $html;
}
- public function execute( $par ) {
+ /**
+ * The main entry point for the page.
+ *
+ * @param int $mode Whether the user is viewing, editing, or clearing
their
+ * watchlist
+ */
+ public function execute( $mode ) {
// Anons don't get a watchlist edit
$this->requireLogin( 'watchlistanontext' );
$out = $this->getOutput();
// turn off #content element
$out->setProperty( 'unstyledContent', true );
- parent::execute( $par );
+ parent::execute( $mode );
$out->setPageTitle( $this->msg( 'watchlist' ) );
}
+ /**
+ * Renders the view/edit (normal) mode of the watchlist.
+ */
protected function executeViewEditWatchlist() {
$html = '';
$total = 0;
--
To view, visit https://gerrit.wikimedia.org/r/169731
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Idf3715538800ea9b85377d0e5048a9290f7ef017
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/MobileFrontend
Gerrit-Branch: master
Gerrit-Owner: Phuedx <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
