From 51adb81e6ee4567fe646bc9b26848f3d0b2a17fe Mon Sep 17 00:00:00 2001 From: umherirrender Date: Sun, 24 Aug 2014 11:19:32 +0200 Subject: [PATCH] Add some @see to doc blocks This avoids repeating the @params for the functions Change-Id: Ie1f4488a0a7aa30ab128b9ea7ff6f3af12a88884 --- includes/GlobalFunctions.php | 5 +++++ includes/Linker.php | 1 + includes/db/DatabasePostgres.php | 1 + 3 files changed, 7 insertions(+) diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index 805ba9e9c6..ddea620b81 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -38,6 +38,7 @@ if ( !defined( 'MEDIAWIKI' ) ) { if ( !function_exists( 'mb_substr' ) ) { /** * @codeCoverageIgnore + * @see Fallback::mb_substr * @return string */ function mb_substr( $str, $start, $count = 'end' ) { @@ -46,6 +47,7 @@ if ( !function_exists( 'mb_substr' ) ) { /** * @codeCoverageIgnore + * @see Fallback::mb_substr_split_unicode * @return int */ function mb_substr_split_unicode( $str, $splitPos ) { @@ -56,6 +58,7 @@ if ( !function_exists( 'mb_substr' ) ) { if ( !function_exists( 'mb_strlen' ) ) { /** * @codeCoverageIgnore + * @see Fallback::mb_strlen * @return int */ function mb_strlen( $str, $enc = '' ) { @@ -66,6 +69,7 @@ if ( !function_exists( 'mb_strlen' ) ) { if ( !function_exists( 'mb_strpos' ) ) { /** * @codeCoverageIgnore + * @see Fallback::mb_strpos * @return int */ function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) { @@ -76,6 +80,7 @@ if ( !function_exists( 'mb_strpos' ) ) { if ( !function_exists( 'mb_strrpos' ) ) { /** * @codeCoverageIgnore + * @see Fallback::mb_strrpos * @return int */ function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) { diff --git a/includes/Linker.php b/includes/Linker.php index 05caeaa60a..05bace5dbf 100644 --- a/includes/Linker.php +++ b/includes/Linker.php @@ -259,6 +259,7 @@ class Linker { /** * Identical to link(), except $options defaults to 'known'. + * @see Linker::link * @return string */ public static function linkKnown( diff --git a/includes/db/DatabasePostgres.php b/includes/db/DatabasePostgres.php index 45fb3f68d3..e1ca0eeac6 100644 --- a/includes/db/DatabasePostgres.php +++ b/includes/db/DatabasePostgres.php @@ -829,6 +829,7 @@ __INDEXATTR__; * so causes a DB error. This wrapper checks which tables can be locked and adjusts it accordingly. * * MySQL uses "ORDER BY NULL" as an optimization hint, but that syntax is illegal in PostgreSQL. + * @see DatabaseBase::selectSQLText */ function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__, $options = array(), $join_conds = array() -- 2.20.1