From a2ea6116af243c8e7940e5eea8b353770502fe17 Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Tue, 28 Apr 2015 21:49:40 -0700 Subject: [PATCH] Fixed some tags for doxygen Change-Id: I550b8760556e4916ee9b63ee244bbbcb4d926142 --- includes/CategoryFinder.php | 4 ++-- includes/Status.php | 4 ++-- includes/jobqueue/JobSpecification.php | 4 ++-- includes/libs/MultiHttpClient.php | 8 ++++---- includes/libs/objectcache/BagOStuff.php | 4 ++-- includes/libs/objectcache/WANObjectCache.php | 8 ++++---- .../libs/virtualrest/VirtualRESTServiceClient.php | 12 ++++++------ includes/profiler/ProfileSection.php | 2 +- 8 files changed, 23 insertions(+), 23 deletions(-) diff --git a/includes/CategoryFinder.php b/includes/CategoryFinder.php index 33de7404eb..77c43bf089 100644 --- a/includes/CategoryFinder.php +++ b/includes/CategoryFinder.php @@ -27,7 +27,7 @@ * articles are in one or all of a given subset of categories. * * Example use : - * + * @code * # Determines whether the article with the page_id 12345 is in both * # "Category 1" and "Category 2" or their subcategories, respectively * @@ -39,7 +39,7 @@ * ); * $a = $cf->run(); * print implode( ',' , $a ); - * + * @endcode * */ class CategoryFinder { diff --git a/includes/Status.php b/includes/Status.php index cd10258d58..fbb5daae20 100644 --- a/includes/Status.php +++ b/includes/Status.php @@ -69,9 +69,9 @@ class Status { * Succinct helper method to wrap a StatusValue * * This is is useful when formatting StatusValue objects: - * + * @code * $this->getOutput()->addHtml( Status::wrap( $sv )->getHTML() ); - * + * @endcode * * @param StatusValue|Status $sv * @return Status diff --git a/includes/jobqueue/JobSpecification.php b/includes/jobqueue/JobSpecification.php index 84cfd47da1..327a18f95a 100644 --- a/includes/jobqueue/JobSpecification.php +++ b/includes/jobqueue/JobSpecification.php @@ -68,7 +68,7 @@ interface IJobSpecification { * Job queue task description base code * * Example usage: - * + * @code * $job = new JobSpecification( * 'null', * array( 'lives' => 1, 'usleep' => 100, 'pi' => 3.141569 ), @@ -76,7 +76,7 @@ interface IJobSpecification { * Title::makeTitle( NS_SPECIAL, 'nullity' ) * ); * JobQueueGroup::singleton()->push( $job ) - * + * @endcode * * @ingroup JobQueue * @since 1.23 diff --git a/includes/libs/MultiHttpClient.php b/includes/libs/MultiHttpClient.php index 8e5c17d04e..16e0d4fcca 100644 --- a/includes/libs/MultiHttpClient.php +++ b/includes/libs/MultiHttpClient.php @@ -90,9 +90,9 @@ class MultiHttpClient { * - body : HTTP response body or resource (if "stream" was set) * - error : Any cURL error string * The map also stores integer-indexed copies of these values. This lets callers do: - * + * @code * list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $http->run( $req ); - * + * @endcode * @param array $req HTTP request array * @param array $opts * - connTimeout : connection timeout per request (seconds) @@ -114,9 +114,9 @@ class MultiHttpClient { * - body : HTTP response body or resource (if "stream" was set) * - error : Any cURL error string * The map also stores integer-indexed copies of these values. This lets callers do: - * + * @code * list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $req['response']; - * + * @endcode * All headers in the 'headers' field are normalized to use lower case names. * This is true for the request headers and the response headers. Integer-indexed * method/URL entries will also be changed to use the corresponding string keys. diff --git a/includes/libs/objectcache/BagOStuff.php b/includes/libs/objectcache/BagOStuff.php index 16f60345ef..5507e9d10e 100644 --- a/includes/libs/objectcache/BagOStuff.php +++ b/includes/libs/objectcache/BagOStuff.php @@ -37,10 +37,10 @@ use Psr\Log\NullLogger; * the PHP memcached client. * * backends for local hash array and SQL table included: - * + * @code * $bag = new HashBagOStuff(); * $bag = new SqlBagOStuff(); # connect to db first - * + * @endcode * * @ingroup Cache */ diff --git a/includes/libs/objectcache/WANObjectCache.php b/includes/libs/objectcache/WANObjectCache.php index be62d1a306..0437fad769 100755 --- a/includes/libs/objectcache/WANObjectCache.php +++ b/includes/libs/objectcache/WANObjectCache.php @@ -320,7 +320,7 @@ class WANObjectCache { * the 'lowTTL' parameter. * * Example usage: - * + * @code * $key = wfMemcKey( 'cat-recent-actions', $catId ); * // Function that derives the new key value given the old value * $callback = function( $cValue ) { ... }; @@ -328,10 +328,10 @@ class WANObjectCache { * // try to only let one cluster thread manage doing cache updates * $opts = array( 'lockTSE' => 5, 'lowTTL' => 10 ); * $value = $cache->getWithSetCallback( $key, $callback, 60, array(), $opts ); - * + * @endcode * * Example usage: - * + * @code * $key = wfMemcKey( 'cat-state', $catId ); * // The "check" keys that represent things the value depends on; * // Calling touchCheckKey() on them invalidates "cat-state" @@ -346,7 +346,7 @@ class WANObjectCache { * // try to only let one cluster thread manage doing cache updates * $opts = array( 'lockTSE' => 5, 'lowTTL' => 10 ); * $value = $cache->getWithSetCallback( $key, $callback, 60, $checkKeys, $opts ); - * + * @endcode * * @see WANObjectCache::get() * diff --git a/includes/libs/virtualrest/VirtualRESTServiceClient.php b/includes/libs/virtualrest/VirtualRESTServiceClient.php index e8bb38d89b..519da4313c 100644 --- a/includes/libs/virtualrest/VirtualRESTServiceClient.php +++ b/includes/libs/virtualrest/VirtualRESTServiceClient.php @@ -127,9 +127,9 @@ class VirtualRESTServiceClient { * - body : HTTP response body or resource (if "stream" was set) * - error : Any cURL error string * The map also stores integer-indexed copies of these values. This lets callers do: - * - * list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $client->run( $req ); - * + * @code + * list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $client->run( $req ); + * @endcode * @param array $req Virtual HTTP request maps * @return array Response array for request */ @@ -148,9 +148,9 @@ class VirtualRESTServiceClient { * - body : HTTP response body or resource (if "stream" was set) * - error : Any cURL error string * The map also stores integer-indexed copies of these values. This lets callers do: - * - * list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $responses[0]; - * + * @code + * list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $responses[0]; + * @endcode * * @param array $reqs Map of Virtual HTTP request maps * @return array $reqs Map of corresponding response values with the same keys/order diff --git a/includes/profiler/ProfileSection.php b/includes/profiler/ProfileSection.php index 68ef668089..9062251021 100644 --- a/includes/profiler/ProfileSection.php +++ b/includes/profiler/ProfileSection.php @@ -35,7 +35,7 @@ class ProfileSection { * the same moment that the function to be profiled terminates. * * This is typically called like: - * $section = new ProfileSection( __METHOD__ ); + * @code$section = new ProfileSection( __METHOD__ );@endcode * * @param string $name Name of the function to profile */ -- 2.20.1