- Fixed spacing inside docs
- Makes beginning of @param/@return in capital
Change-Id: I864b8b3f1f67e34e369aba7aadaf87e7752c894d
/**
* Get the hook documentation, either locally or from MediaWiki.org
/**
* Get the hook documentation, either locally or from MediaWiki.org
- * @return array of documented hooks
+ * @return Array of documented hooks
*/
private function getHooksFromDoc( $doc ) {
if ( $this->hasOption( 'online' ) ) {
*/
private function getHooksFromDoc( $doc ) {
if ( $this->hasOption( 'online' ) ) {
/**
* Get hooks from a local file (for example docs/hooks.txt)
/**
* Get hooks from a local file (for example docs/hooks.txt)
- * @param string $doc filename to look in
- * @return array Array of documented hooks
+ * @param string $doc Filename to look in
+ * @return Array of documented hooks
*/
private function getHooksFromLocalDoc( $doc ) {
$m = array();
*/
private function getHooksFromLocalDoc( $doc ) {
$m = array();
/**
* Get hooks from www.mediawiki.org using the API
/**
* Get hooks from www.mediawiki.org using the API
- * @return array of documented hooks
+ * @return Array of documented hooks
*/
private function getHooksFromOnlineDoc() {
// All hooks
*/
private function getHooksFromOnlineDoc() {
// All hooks
/**
* Get hooks from a PHP file
* @param string $file Full filename to the PHP file.
/**
* Get hooks from a PHP file
* @param string $file Full filename to the PHP file.
- * @return array of hooks found.
+ * @return Array of hooks found.
*/
private function getHooksFromFile( $file ) {
$content = file_get_contents( $file );
*/
private function getHooksFromFile( $file ) {
$content = file_get_contents( $file );
/**
* Get hooks from the source code.
* @param string $path Directory where the include files can be found
/**
* Get hooks from the source code.
* @param string $path Directory where the include files can be found
- * @return array Array of hooks found.
+ * @return Array of hooks found.
*/
private function getHooksFromPath( $path ) {
$hooks = array();
*/
private function getHooksFromPath( $path ) {
$hooks = array();
/**
* Get bad hooks (where the hook name could not be determined) from a PHP file
* @param string $file Full filename to the PHP file.
/**
* Get bad hooks (where the hook name could not be determined) from a PHP file
* @param string $file Full filename to the PHP file.
- * @return array Array of bad wfRunHooks() lines
+ * @return Array of bad wfRunHooks() lines
*/
private function getBadHooksFromFile( $file ) {
$content = file_get_contents( $file );
*/
private function getBadHooksFromFile( $file ) {
$content = file_get_contents( $file );
/**
* Get bad hooks from the source code.
* @param string $path Directory where the include files can be found
/**
* Get bad hooks from the source code.
* @param string $path Directory where the include files can be found
- * @return array Array of bad wfRunHooks() lines
+ * @return Array of bad wfRunHooks() lines
*/
private function getBadHooksFromPath( $path ) {
$hooks = array();
*/
private function getBadHooksFromPath( $path ) {
$hooks = array();
/** @var array Magic words */
protected $mMagicWords;
/** @var array Magic words */
protected $mMagicWords;
- /** @var array Special page aliases */
+ /** @var array Special page aliases */
protected $mSpecialPageAliases;
/**
protected $mSpecialPageAliases;
/**
* Default title is 'CLIParser', it can be overriden with the option
* --title <Your:Title>
*
* Default title is 'CLIParser', it can be overriden with the option
* --title <Your:Title>
*
*/
protected function getTitle() {
$title = $this->getOption( 'title' )
*/
protected function getTitle() {
$title = $this->getOption( 'title' )
/**
* Print the results, callback for $db->sourceStream()
* @param ResultWrapper $res The results object
/**
* Print the results, callback for $db->sourceStream()
* @param ResultWrapper $res The results object
- * @param DatabaseBase $db object
+ * @param DatabaseBase $db
*/
public function sqlPrintResult( $res, $db ) {
if ( !$res ) {
*/
public function sqlPrintResult( $res, $db ) {
if ( !$res ) {
* Will throw exceptions on SQL errors
* @param array|string $files
* @throws MWException
* Will throw exceptions on SQL errors
* @param array|string $files
* @throws MWException
- * @return string|bool true if no error or error string in case of errors
+ * @return True if no error or error string in case of errors
*/
public static function checkSqlSyntax( $files ) {
if ( !Sqlite::isPresent() ) {
*/
public static function checkSqlSyntax( $files ) {
if ( !Sqlite::isPresent() ) {