Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/382606 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ia1f55dbc7d9cc9395d91b471911c9e4546b08afe
---
M api/ApiFeedLQTThreads.php
M api/ApiQueryLQTThreads.php
M api/ApiThreadAction.php
M classes/DeletionController.php
M classes/Dispatch.php
M classes/Hooks.php
M classes/NewMessagesController.php
M classes/ParserFunctions.php
M classes/Thread.php
M classes/Threads.php
M classes/View.php
M pages/NewUserMessagesView.php
M pages/SpecialMergeThread.php
M pages/SpecialMoveThread.php
M pages/SpecialNewMessages.php
M pages/SpecialSplitThread.php
M pages/TalkpageView.php
M phpcs.xml
18 files changed, 213 insertions(+), 167 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/LiquidThreads
refs/changes/06/382606/1
diff --git a/api/ApiFeedLQTThreads.php b/api/ApiFeedLQTThreads.php
index 3e4a900..d29e4c3 100644
--- a/api/ApiFeedLQTThreads.php
+++ b/api/ApiFeedLQTThreads.php
@@ -149,8 +149,8 @@
}
/**
- * @param $params array
- * @param $db DatabaseBase
+ * @param array $params
+ * @param DatabaseBase $db
* @return array
*/
function getConditions( $params, $db ) {
@@ -245,6 +245,7 @@
/**
* @see ApiBase::getExamplesMessages()
+ * @return array
*/
protected function getExamplesMessages() {
return [
diff --git a/api/ApiQueryLQTThreads.php b/api/ApiQueryLQTThreads.php
index 404e73d..45d9ec2 100644
--- a/api/ApiQueryLQTThreads.php
+++ b/api/ApiQueryLQTThreads.php
@@ -410,6 +410,7 @@
/**
* @see ApiBase::getExamplesMessages()
+ * @return array
*/
protected function getExamplesMessages() {
return [
diff --git a/api/ApiThreadAction.php b/api/ApiThreadAction.php
index 0259b15..e0f8ecf 100644
--- a/api/ApiThreadAction.php
+++ b/api/ApiThreadAction.php
@@ -697,8 +697,8 @@
}
/**
- * @param $thread Thread
- * @return String
+ * @param Thread $thread
+ * @return string
*/
protected function renderThreadPostAction( $thread ) {
$thread = $thread->topmostThread();
@@ -1020,6 +1020,7 @@
/**
* @see ApiBase::getExamplesMessages()
+ * @return array
*/
protected function getExamplesMessages() {
return [
diff --git a/classes/DeletionController.php b/classes/DeletionController.php
index 7264865..46386ee 100644
--- a/classes/DeletionController.php
+++ b/classes/DeletionController.php
@@ -95,9 +95,9 @@
}
/**
- * @param $article Article
- * @param $out OutputPage
- * @param $reason string
+ * @param Article $article
+ * @param OutputPage $out
+ * @param string &$reason
* @return bool
*/
public static function onArticleConfirmDelete( $article, $out, &$reason
) {
diff --git a/classes/Dispatch.php b/classes/Dispatch.php
index 74d2c5a..4fdc132 100644
--- a/classes/Dispatch.php
+++ b/classes/Dispatch.php
@@ -6,11 +6,11 @@
public static $primaryView = null;
/**
- * @param $output OutputPage
- * @param $article Article
- * @param $title Title
- * @param $user User
- * @param $request WebRequest
+ * @param OutputPage &$output
+ * @param Article &$article
+ * @param Title &$title
+ * @param User &$user
+ * @param WebRequest &$request
* @return bool
*/
public static function talkpageMain( &$output, &$article, &$title,
&$user, &$request ) {
@@ -66,11 +66,11 @@
}
/**
- * @param $output OutputPage
- * @param $article Article
- * @param $title Title
- * @param $user User
- * @param $request WebRequest
+ * @param OutputPage &$output
+ * @param Article &$article
+ * @param Title &$title
+ * @param User &$user
+ * @param WebRequest &$request
* @return bool
*/
public static function threadPermalinkMain( &$output, &$article,
&$title, &$user, &$request ) {
@@ -110,7 +110,7 @@
}
/**
- * @param $title Title
+ * @param Title $title
* @return bool|null
*/
public static function isLqtPage( $title ) {
@@ -150,7 +150,7 @@
}
/**
- * @param $title Title
+ * @param Title $title
* @return null|int
*/
public static function getUserLqtOverride( $title ) {
@@ -208,11 +208,11 @@
/**
* If the page we recieve is a LiquidThreads page of any kind, process
it
* as needed and return True. If it's a normal, non-liquid page, return
false.
- * @param $output OutputPage
- * @param $article Article
- * @param $title Title
- * @param $user User
- * @param $request WebRequest
+ * @param OutputPage $output
+ * @param Article $article
+ * @param Title $title
+ * @param User $user
+ * @param WebRequest $request
* @return bool
*/
public static function tryPage( $output, $article, $title, $user,
$request ) {
@@ -241,9 +241,9 @@
/**
* Most stuff is in the user language.
- * @param $title Title
- * @param $pageLang
- * @param $wgLang
+ * @param Title $title
+ * @param Language|string &$pageLang
+ * @param Language $wgLang
* @return bool
*/
public static function onPageContentLanguage( $title, &$pageLang,
$wgLang ) {
diff --git a/classes/Hooks.php b/classes/Hooks.php
index 9dcd91d..9c900b4 100644
--- a/classes/Hooks.php
+++ b/classes/Hooks.php
@@ -29,9 +29,10 @@
];
/**
- * @param $changeslist ChangesList
- * @param $s string
- * @param $rc RecentChange
+ * @param ChangesList &$changeslist
+ * @param string &$s
+ * @param RecentChange $rc
+ * @param array &$classes
* @return bool
*/
static function customizeOldChangesList( &$changeslist, &$s, $rc,
&$classes ) {
@@ -186,7 +187,7 @@
}
/**
- * @param $article Article
+ * @param Article $article
* @return bool
*/
static function updateNewtalkOnEdit( $article ) {
@@ -298,7 +299,7 @@
/**
* For integration with the UserMerge extension.
*
- * @param array $updateFields
+ * @param array &$updateFields
* @return bool
*/
public static function onUserMergeAccountFields( &$updateFields ) {
@@ -312,8 +313,8 @@
/**
* Handle EditPageGetCheckboxesDefinition hook
*
- * @param $editPage EditPage
- * @param $checkboxes
+ * @param EditPage $editPage
+ * @param array &$checkboxes
* @return bool
*/
public static function editCheckboxes( $editPage, &$checkboxes ) {
@@ -380,7 +381,7 @@
}
/**
- * @param $updater DatabaseUpdater
+ * @param DatabaseUpdater|null $updater
* @return bool
*/
public static function onLoadExtensionSchemaUpdates( $updater = null ) {
@@ -473,10 +474,10 @@
}
/**
- * @param $user User
- * @param $title Title
- * @param $isBlocked bool
- * @param $allowUserTalk bool
+ * @param User $user
+ * @param Title $title
+ * @param bool &$isBlocked
+ * @param bool &$allowUserTalk
* @return bool
*/
static function userIsBlockedFrom( $user, $title, &$isBlocked,
&$allowUserTalk ) {
@@ -568,17 +569,17 @@
}
/**
- * @param $article Article
- * @param $user User
- * @param $content Content
- * @param $summary
- * @param $minoredit
- * @param $watchthis
- * @param $sectionanchor
- * @param $flags
- * @param $revision
- * @param $status Status
- * @param $baseRevId
+ * @param Article &$article
+ * @param User &$user
+ * @param Content $content
+ * @param string $summary
+ * @param bool $minoredit
+ * @param bool $watchthis
+ * @param string $sectionanchor
+ * @param int &$flags
+ * @param Revision $revision
+ * @param Status &$status
+ * @param int $baseRevId
* @return bool
*/
static function onPageContentSaveComplete( &$article, &$user, $content,
$summary,
@@ -620,8 +621,8 @@
}
/**
- * @param $title Title
- * @param $types
+ * @param Title $title
+ * @param array &$types
* @return bool
*/
static function getProtectionTypes( $title, &$types ) {
@@ -645,7 +646,7 @@
}
/**
- * @param $vars sttsu
+ * @param array &$vars
* @return bool
*/
public static function onMakeGlobalVariablesScript( &$vars ) {
@@ -657,7 +658,7 @@
/**
* Returns the text contents of a template page set in given key
contents
* Returns empty string if no text could be retrieved.
- * @param $key String: message key that should contain a template page
name
+ * @param string $key message key that should contain a template page
name
* @return String
*/
private static function getTextForPageInKey( $key ) {
@@ -682,6 +683,9 @@
/**
* Handles tags in Page sections of XML dumps
+ * @param XMLReader $reader
+ * @param array &$pageInfo
+ * @return false
*/
public static function handlePageXMLTag( $reader, &$pageInfo ) {
if ( !isset( $reader->nodeType ) || !( $reader->nodeType ==
XmlReader::ELEMENT &&
@@ -725,11 +729,11 @@
/**
* Processes discussion threading data in XML dumps (extracted in
handlePageXMLTag).
*
- * @param $title Title
- * @param $origTitle Title
- * @param $revCount
- * @param $sRevCount
- * @param $pageInfo
+ * @param Title $title
+ * @param Title $origTitle
+ * @param int $revCount
+ * @param int $sRevCount
+ * @param array $pageInfo
* @return bool
*/
public static function afterImportPage( $title, $origTitle, $revCount,
$sRevCount, $pageInfo ) {
@@ -823,8 +827,8 @@
}
/**
- * @param $pendingRelationship
- * @param $title Title
+ * @param array $pendingRelationship
+ * @param Title $title
*/
public static function applyPendingArticleRelationship(
$pendingRelationship, $title ) {
$articleID = $title->getArticleID();
@@ -895,10 +899,10 @@
/**
* Do not allow users to read threads on talkpages that they cannot
read.
*
- * @param $title Title
- * @param $user
- * @param $action
- * @param $result
+ * @param Title $title
+ * @param User $user
+ * @param string $action
+ * @param bool &$result
* @return bool
*/
public static function onGetUserPermissionsErrors( $title, $user,
$action, &$result ) {
@@ -925,7 +929,7 @@
}
/**
- * @param $parser Parser
+ * @param Parser $parser
* @return bool
*/
public static function onParserFirstCallInit( $parser ) {
@@ -950,7 +954,7 @@
}
/**
- * @param $list array
+ * @param array &$list
* @return bool
*/
public static function onCanonicalNamespaces( &$list ) {
diff --git a/classes/NewMessagesController.php
b/classes/NewMessagesController.php
index 1ab126e..a56c020 100644
--- a/classes/NewMessagesController.php
+++ b/classes/NewMessagesController.php
@@ -138,6 +138,9 @@
/**
* Write a user_message_state for each user who is watching the thread.
* If the thread is on a user's talkpage, set that user's newtalk.
+ * @param Thread $t
+ * @param string $type
+ * @param User $changeUser
*/
static function writeMessageStateForUpdatedThread( $t, $type,
$changeUser ) {
wfDebugLog( 'LiquidThreads', 'Doing notifications' );
diff --git a/classes/ParserFunctions.php b/classes/ParserFunctions.php
index 50060b6..eda778c 100644
--- a/classes/ParserFunctions.php
+++ b/classes/ParserFunctions.php
@@ -21,9 +21,15 @@
}
/** To bypass the parser cache just for the LiquidThreads part, we have
a cute trick.
- * We leave a placeholder comment in the HTML, which we expand out in
a hook. This way,
- * most of the page can be cached, but the LiquidThreads dynamism
still works.
- * Thanks to Tim for the idea. */
+ * We leave a placeholder comment in the HTML, which we expand out in a
hook. This way,
+ * most of the page can be cached, but the LiquidThreads dynamism still
works.
+ * Thanks to Tim for the idea.
+ * @param string $content
+ * @param array $args
+ * @param Parser $parser
+ * @param Frame $frame
+ * @return string
+ */
static function lqtTalkPage( $content, $args, $parser, $frame ) {
$pout = $parser->getOutput();
diff --git a/classes/Thread.php b/classes/Thread.php
index 510710e..088bec5 100644
--- a/classes/Thread.php
+++ b/classes/Thread.php
@@ -255,7 +255,10 @@
}
}
- /** Unless you know what you're doing, you want commitRevision */
+ /**
+ * Unless you know what you're doing, you want commitRevision
+ * @param string|null $fname
+ */
public function save( $fname = null ) {
$this->dieIfHistorical();
@@ -763,9 +766,9 @@
}
/**
- * Return the User object representing the author of the first revision
- * (or null, if the database is screwed up).
- */
+ * @return User|null the User object representing the author of the
first revision
+ * (or null, if the database is screwed up).
+ */
public function loadOriginalAuthorFromRevision() {
$this->dieIfHistorical();
@@ -1672,7 +1675,7 @@
}
/**
- * Return the Title object for the article this thread is attached to.
+ * @return Title the Title object for the article this thread is
attached to.
*/
public function getTitle() {
return $this->article()->getTitle();
diff --git a/classes/Threads.php b/classes/Threads.php
index 34156eb..2cffa92 100644
--- a/classes/Threads.php
+++ b/classes/Threads.php
@@ -57,7 +57,7 @@
* Create the talkpage if it doesn't exist so that links to it
* will show up blue instead of red. For use upon new thread creation.
*
- * @param $talkpage Article
+ * @param Article $talkpage
*/
public static function createTalkpageIfNeeded( $talkpage ) {
if ( !$talkpage->exists() ) {
@@ -132,8 +132,8 @@
}
/**
- * @param $post Article
- * @param $bulkLoad bool
+ * @param Article $post
+ * @param bool $bulkLoad
* @return Thread
*/
public static function withRoot( $post, $bulkLoad = true ) {
@@ -157,8 +157,8 @@
}
/**
- * @param $id
- * @param $bulkLoad bool
+ * @param string $id
+ * @param bool $bulkLoad
* @return Thread
*/
public static function withId( $id, $bulkLoad = true ) {
@@ -172,8 +172,8 @@
}
/**
- * @param $article
- * @param $bulkLoad bool
+ * @param Article $article
+ * @param bool $bulkLoad
* @return Thread
*/
public static function withSummary( $article, $bulkLoad = true ) {
@@ -273,7 +273,12 @@
return StringUtils::delimiterReplace( '<', '>', '', $text );
}
- /** Keep trying titles starting with $basename until one is unoccupied.
*/
+ /**
+ * Keep trying titles starting with $basename until one is unoccupied.
+ * @param string $basename
+ * @param int $namespace
+ * @return Title
+ */
public static function incrementedTitle( $basename, $namespace ) {
global $wgContLang;
$i = 2;
diff --git a/classes/View.php b/classes/View.php
index 2a83ab3..7d6ba07 100644
--- a/classes/View.php
+++ b/classes/View.php
@@ -62,11 +62,20 @@
* (2) figuring out what page you're on and what you need to do.
*************************/
+ /**
+ * @param string $method
+ * @param Thread $thread
+ * @return bool
+ */
function methodAppliesToThread( $method, $thread ) {
return $this->request->getVal( 'lqt_method' ) == $method &&
$this->request->getVal( 'lqt_operand' ) ==
$thread->id();
}
+ /**
+ * @param string $method
+ * @return bool
+ */
function methodApplies( $method ) {
return $this->request->getVal( 'lqt_method' ) == $method;
}
@@ -88,9 +97,9 @@
/**
* Gets an array of (title, query-parameters) for a permalink
- * @param $thread Thread
- * @param $method null
- * @param $operand null
+ * @param Thread $thread
+ * @param null $method
+ * @param null $operand
* @throws MWException
* @return array
*/
@@ -143,8 +152,8 @@
}
/**
- * @param $thread Thread
- * @param $contextType string
+ * @param Thread $thread
+ * @param string $contextType
* @throws Exception
* @return array
*/
@@ -175,9 +184,9 @@
}
/**
- * @param $thread thread
- * @param $contextType string
- * @param $text null
+ * @param thread $thread
+ * @param string $contextType
+ * @param null $text
* @return mixed
*/
static function linkInContext( $thread, $contextType = 'page', $text =
null ) {
@@ -214,8 +223,8 @@
}
/**
- * @param $thread
- * @param $revision Revision
+ * @param Thread $thread
+ * @param Revision $revision
* @return array
*/
static function diffQuery( $thread, $revision ) {
@@ -265,11 +274,11 @@
}
/**
- * @param $title Title
- * @param $method null
- * @param $operand null
- * @param $includeFragment bool
- * @param $perpetuateOffset bool
+ * @param Title $title
+ * @param null $method
+ * @param null $operand
+ * @param bool $includeFragment
+ * @param bool $perpetuateOffset
* @return array
*/
static function talkpageLinkData( $title, $method = null, $operand =
null,
@@ -318,12 +327,12 @@
/**
* If you want $perpetuateOffset to perpetuate from a specific request,
* pass that instead of true
- * @param $title Title
- * @param $method null
- * @param $operand null
- * @param $includeFragment bool
- * @param $perpetuateOffset bool
- * @return
+ * @param Title $title
+ * @param null $method
+ * @param null $operand
+ * @param bool $includeFragment
+ * @param bool $perpetuateOffset
+ * @return string
*/
static function talkpageUrl( $title, $method = null, $operand = null,
$includeFragment = true, $perpetuateOffset = true
@@ -338,7 +347,8 @@
/**
* Return a URL for the current page, including Title and query vars,
* with the given replacements made.
- * @param $repls array( 'name'=>new_value, ... )
+ * @param array $repls array( 'name'=>new_value, ... )
+ * @return string
*/
function queryReplaceLink( $repls ) {
$query = $this->getReplacedQuery( $repls );
@@ -365,6 +375,9 @@
/**
* Return an HTML form element whose value is gotten from the request.
* @todo Figure out a clean way to expand this to other forms.
+ * @param string $name
+ * @param string $as
+ * @return string
*/
function perpetuate( $name, $as = 'hidden' ) {
$value = $this->request->getVal( $name, '' );
@@ -376,7 +389,7 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
*/
function showReplyProtectedNotice( $thread ) {
$log_url = SpecialPage::getTitleFor( 'Log' )->getLocalURL(
@@ -441,7 +454,7 @@
/**
* Workaround for bug 27887 caused by r82686
- * @param $request FauxRequest object to have session data injected
into.
+ * @param FauxRequest $request FauxRequest object to have session data
injected into.
*/
static function fixFauxRequestSession( $request ) {
// This is sometimes called before session_start (bug 28826).
@@ -455,9 +468,9 @@
}
/**
- * @param $talkpage Thread
- * @param $method
- * @param $operand
+ * @param Thread $talkpage
+ * @param string $method
+ * @param string $operand
* @return String
* @throws Exception
*/
@@ -501,7 +514,7 @@
}
/**
- * @param $talkpage Thread
+ * @param Thread $talkpage
*/
function showNewThreadForm( $talkpage ) {
$submitted_nonce = $this->request->getVal( 'lqt_nonce' );
@@ -622,7 +635,7 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
*/
function showReplyForm( $thread ) {
global $wgRequest;
@@ -735,7 +748,7 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
*/
function showPostEditingForm( $thread ) {
$submitted_nonce = $this->request->getVal( 'lqt_nonce' );
@@ -847,7 +860,7 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
*/
function showSummarizeForm( $thread ) {
$submitted_nonce = $this->request->getVal( 'lqt_nonce' );
@@ -1114,9 +1127,9 @@
}
/**
- * @param $t Thread
- * @param $s
- * @param $reason
+ * @param Thread $t
+ * @param string $s
+ * @param string $reason
*/
function renameThread( $t, $s, $reason ) {
$this->simplePageMove( $t->root()->getTitle(), $s, $reason );
@@ -1128,7 +1141,7 @@
}
/**
- * @param $subject
+ * @param string $subject
* @return Title
*/
function newThreadTitle( $subject ) {
@@ -1136,7 +1149,7 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
* @return Title
*/
function newSummaryTitle( $thread ) {
@@ -1144,8 +1157,8 @@
}
/**
- * @param $unused
- * @param $thread Thread
+ * @param mixed $unused
+ * @param Thread $thread
* @return Title
*/
function newReplyTitle( $unused, $thread ) {
@@ -1154,7 +1167,9 @@
/*
* Adapted from MovePageForm::doSubmit in SpecialMovepage.php.
- * @param $old_title Title
+ * @param Title $old_title
+ * @param string $new_subject
+ * @param string $reason
*/
function simplePageMove( $old_title, $new_subject, $reason ) {
if ( $this->user->pingLimiter( 'move' ) ) {
@@ -1185,8 +1200,8 @@
}
/**
- * @param $thread Thread
- * Example return value:
+ * @param Thread $thread
+ * @return array Example return value:
* array (
* edit => array( 'label' => 'Edit',
* 'href' => 'http...',
@@ -1280,7 +1295,8 @@
/**
* Commands for the bottom.
- * @param $thread Thread
+ * @param Thread $thread
+ * @return array
*/
function threadMajorCommands( $thread ) {
$isLqtPage = LqtDispatch::isLqtPage( $thread->getTitle() );
@@ -1353,7 +1369,8 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
+ * @return array
*/
function topLevelThreadCommands( $thread ) {
$commands = [];
@@ -1434,8 +1451,8 @@
}
/**
- * @param $post
- * @param $oldid null
+ * @param mixed $post
+ * @param null $oldid
* @return bool false if the article and revision do not exist. The
HTML of the page to
* display if it exists. Note that this impacts the state out
OutputPage by adding
* all the other relevant parts of the parser output. If you don't want
this, call
@@ -1459,7 +1476,7 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
* @return string
*/
function showThreadToolbar( $thread ) {
@@ -1556,7 +1573,7 @@
/**
* Shows a normal (i.e. not deleted or moved) thread body
- * @param $thread Thread
+ * @param Thread $thread
*/
function showThreadBody( $thread ) {
// Remove 'editsection', it won't work.
@@ -1616,7 +1633,8 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
+ * @return string
*/
function threadSignature( $thread ) {
global $wgLang;
@@ -1643,7 +1661,8 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
+ * @return string
*/
function threadInfoPanel( $thread ) {
global $wgLang;
@@ -1703,7 +1722,8 @@
/**
* Shows the headING for a thread (as opposed to the headeER for a post
within
* a thread).
- * @param $thread Thread
+ * @param Thread $thread
+ * @return string
*/
function showThreadHeading( $thread ) {
global $wgContLang;
@@ -1756,7 +1776,8 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
+ * @return string
*/
static function anchorName( $thread ) {
return $thread->getAnchorName();
@@ -1765,7 +1786,7 @@
/**
* Display a moved thread
*
- * @param $thread Thread
+ * @param Thread $thread
* @throws Exception
*/
function showMovedThread( $thread ) {
@@ -1806,6 +1827,8 @@
/**
* Shows a deleted thread. Returns true to show the thread body
+ * @param Thread $thread
+ * @return bool
*/
function showDeletedThread( $thread ) {
if ( $this->user->isAllowed( 'deletedhistory' ) ) {
@@ -1824,7 +1847,7 @@
/**
* Shows a single thread, rather than a thread tree.
*
- * @param $thread Thread
+ * @param Thread $thread
*/
function showSingleThread( $thread ) {
$html = '';
@@ -1888,9 +1911,9 @@
}
/**
- * @param $thread Thread
- * @param $st
- * @param $i
+ * @param Thread $thread
+ * @param string $st
+ * @param string $i
* @return string
*/
function getShowMore( $thread, $st, $i ) {
@@ -1915,7 +1938,7 @@
* When some replies are hidden because the are nested too deep,
* this method creates a link that can be used to show the hidden
* threats.
- * @param $thread Thread
+ * @param Thread $thread
* @return string Html
*/
function getShowReplies( Thread $thread ) {
@@ -1938,7 +1961,7 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
* @return bool
*/
static function threadContainsRepliesWithContent( $thread ) {
@@ -1968,12 +1991,12 @@
}
/**
- * @param $thread Thread
- * @param $startAt
- * @param $maxCount
- * @param $showThreads
- * @param $cascadeOptions
- * @param $interruption bool
+ * @param Thread $thread
+ * @param int $startAt
+ * @param int $maxCount
+ * @param bool $showThreads
+ * @param array $cascadeOptions
+ * @param bool $interruption
*/
function showThreadReplies( $thread, $startAt, $maxCount, $showThreads,
$cascadeOptions, $interruption = false ) {
@@ -2047,10 +2070,10 @@
}
/**
- * @param $thread Thread
- * @param $levelNum int
- * @param $totalInLevel int
- * @param $options array
+ * @param Thread $thread
+ * @param int $levelNum
+ * @param int $totalInLevel
+ * @param array $options
* @throws Exception
*/
function showThread( $thread, $levelNum = 1, $totalInLevel = 1,
@@ -2296,7 +2319,7 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
*/
function showReplyBox( $thread ) {
// Check if we're actually replying to this thread.
@@ -2318,7 +2341,7 @@
}
/**
- * @param $thread Thread
+ * @param Thread $thread
* @return string
*/
function threadDivClass( $thread ) {
@@ -2331,7 +2354,7 @@
}
/**
- * @param $t Thread
+ * @param Thread $t
* @return string
*/
function getSummary( $t ) {
@@ -2443,8 +2466,8 @@
}
/**
- * @param $sig
- * @param $user User
+ * @param string $sig
+ * @param User $user
* @return string
*/
static function signaturePST( $sig, $user ) {
diff --git a/pages/NewUserMessagesView.php b/pages/NewUserMessagesView.php
index d760e7d..e8786a9 100644
--- a/pages/NewUserMessagesView.php
+++ b/pages/NewUserMessagesView.php
@@ -208,6 +208,7 @@
* Returns an array of structures. Each structure has the keys 'top'
and 'posts'.
* 'top' contains the top-level thread to display.
* 'posts' contains an array of integer post IDs which should be
highlighted.
+ * @return false|array
*/
function getThreads() {
$rows = $this->getRows();
diff --git a/pages/SpecialMergeThread.php b/pages/SpecialMergeThread.php
index f8eae74..b448e78 100644
--- a/pages/SpecialMergeThread.php
+++ b/pages/SpecialMergeThread.php
@@ -68,8 +68,9 @@
}
/**
- * @see SpecialPage::getDescription
- */
+ * @see SpecialPage::getDescription
+ * @return string
+ */
function getDescription() {
return $this->msg( 'lqt_merge_thread' )->text();
}
diff --git a/pages/SpecialMoveThread.php b/pages/SpecialMoveThread.php
index 1c03d82..308b63e 100644
--- a/pages/SpecialMoveThread.php
+++ b/pages/SpecialMoveThread.php
@@ -5,6 +5,7 @@
class SpecialMoveThread extends ThreadActionPage {
/**
* @see SpecialPage::getDescription
+ * @return string
*/
function getDescription() {
return $this->msg( 'lqt_movethread' )->text();
diff --git a/pages/SpecialNewMessages.php b/pages/SpecialNewMessages.php
index 6d8e20b..89f8309 100644
--- a/pages/SpecialNewMessages.php
+++ b/pages/SpecialNewMessages.php
@@ -12,6 +12,7 @@
/**
* @see SpecialPage::getDescription
+ * @return string
*/
function getDescription() {
return $this->msg( 'lqt_newmessages-title' )->text();
diff --git a/pages/SpecialSplitThread.php b/pages/SpecialSplitThread.php
index 40fcf40..6e9634d 100644
--- a/pages/SpecialSplitThread.php
+++ b/pages/SpecialSplitThread.php
@@ -23,8 +23,9 @@
}
/**
- * @see SpecialPage::getDescription
- */
+ * @see SpecialPage::getDescription
+ * @return string
+ */
function getDescription() {
return $this->msg( 'lqt_split_thread' )->text();
}
diff --git a/pages/TalkpageView.php b/pages/TalkpageView.php
index a3795ee..25e0897 100644
--- a/pages/TalkpageView.php
+++ b/pages/TalkpageView.php
@@ -544,6 +544,7 @@
/**
* A navigation bar with images
* Stolen from TablePager because it's pretty.
+ * @return string
*/
function getNavigationBar() {
if ( method_exists( $this, 'isNavigationBarShown' ) &&
diff --git a/phpcs.xml b/phpcs.xml
index 107aae8..861e352 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -4,11 +4,6 @@
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturnType" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle"
/>
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
@@ -30,6 +25,4 @@
<file>.</file>
<arg name="extensions" value="php,php5,inc"/>
<arg name="encoding" value="UTF-8"/>
- <exclude-pattern>vendor</exclude-pattern>
- <exclude-pattern>node_modules</exclude-pattern>
</ruleset>
--
To view, visit https://gerrit.wikimedia.org/r/382606
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia1f55dbc7d9cc9395d91b471911c9e4546b08afe
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/LiquidThreads
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
