Normalize PHPDoc attributes
authorMax Semenik <maxsem.wiki@gmail.com>
Sat, 17 Mar 2018 05:30:19 +0000 (22:30 -0700)
committerMax Semenik <maxsem.wiki@gmail.com>
Sat, 17 Mar 2018 05:59:15 +0000 (22:59 -0700)
Change-Id: I83e686d099de0ff0aacda7e332972e1c7ee49f04

includes/diff/TableDiffFormatter.php
includes/htmlform/HTMLForm.php
includes/libs/virtualrest/SwiftVirtualRESTService.php
includes/parser/StripState.php
includes/profiler/ProfileSection.php
includes/resourceloader/ResourceLoaderModule.php

index 14307b5..67f9a79 100644 (file)
@@ -38,7 +38,6 @@ class TableDiffFormatter extends DiffFormatter {
        }
 
        /**
-        * @static
         * @param string $msg
         *
         * @return mixed
index 78e7625..9b58f92 100644 (file)
@@ -504,7 +504,7 @@ class HTMLForm extends ContextSource {
        /**
         * Prepare form for submission.
         *
-        * @attention When doing method chaining, that should be the very last
+        * @warning When doing method chaining, that should be the very last
         * method call before displayForm().
         *
         * @throws MWException
@@ -1006,7 +1006,7 @@ class HTMLForm extends ContextSource {
         * Display the form (sending to the context's OutputPage object), with an
         * appropriate error message or stack of messages, and any validation errors, etc.
         *
-        * @attention You should call prepareForm() before calling this function.
+        * @warning You should call prepareForm() before calling this function.
         * Moreover, when doing method chaining this should be the very last method
         * call just after prepareForm().
         *
index 679d51c..e00bee3 100644 (file)
@@ -22,7 +22,7 @@
 
 /**
  * Example virtual rest service for OpenStack Swift
- * @TODO: caching support (APC/memcached)
+ * @todo caching support (APC/memcached)
  * @since 1.23
  */
 class SwiftVirtualRESTService extends VirtualRESTService {
index d329f69..855ce1d 100644 (file)
@@ -199,7 +199,7 @@ class StripState {
        /**
         * Get an array of parameters to pass to ParserOutput::setLimitReportData()
         *
-        * @unstable Should only be called by Parser
+        * @internal Should only be called by Parser
         * @return array
         */
        public function getLimitReport() {
index d48f744..124e2d3 100644 (file)
@@ -35,7 +35,7 @@ class ProfileSection {
         * the same moment that the function to be profiled terminates.
         *
         * This is typically called like:
-        * @code$section = new ProfileSection( __METHOD__ );@endcode
+        * @code $section = new ProfileSection( __METHOD__ ); @endcode
         *
         * @param string $name Name of the function to profile
         */
index 3be687b..8bf7170 100644 (file)
@@ -620,7 +620,7 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
         *             'https://example.org/image.png' => [ 'as' => 'image' ],
         *         ];
         *     }
-        * @encode
+        * @endcode
         *
         * @par Example using HiDPI image variants
         * @code
@@ -636,7 +636,7 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
         *             ],
         *         ];
         *     }
-        * @encode
+        * @endcode
         *
         * @see ResourceLoaderModule::getHeaders
         * @since 1.30