Browse Source

Correct HTML uppercasing in doc blocks.

Mark Scherer 11 years ago
parent
commit
0a7effa9d5

+ 1 - 1
src/Controller/Component/RequestHandlerComponent.php

@@ -179,7 +179,7 @@ class RequestHandlerComponent extends Component
      * determines which type will be set.
      *
      * If html is one of the preferred types, no content type will be set, this
-     * is to avoid issues with browsers that prefer html and several other content types.
+     * is to avoid issues with browsers that prefer HTML and several other content types.
      *
      * @param \Cake\Network\Request $request The request instance.
      * @param \Cake\Network\Response $response The response instance.

+ 3 - 3
src/Utility/Text.php

@@ -379,13 +379,13 @@ class Text
      *
      * ### Options:
      *
-     * - `format` The piece of html with that the phrase will be highlighted
+     * - `format` The piece of HTML with that the phrase will be highlighted
      * - `html` If true, will ignore any HTML tags, ensuring that only the correct text is highlighted
      * - `regex` a custom regex rule that is used to match words, default is '|$tag|iu'
      *
      * @param string $text Text to search the phrase in.
      * @param string|array $phrase The phrase or phrases that will be searched.
-     * @param array $options An array of html attributes and options.
+     * @param array $options An array of HTML attributes and options.
      * @return string The highlighted text
      * @link http://book.cakephp.org/3.0/en/core-libraries/string.html#highlighting-substrings
      */
@@ -490,7 +490,7 @@ class Text
      *
      * @param string $text String to truncate.
      * @param int $length Length of returned string, including ellipsis.
-     * @param array $options An array of html attributes and options.
+     * @param array $options An array of HTML attributes and options.
      * @return string Trimmed string.
      * @link http://book.cakephp.org/3.0/en/core-libraries/string.html#truncating-text
      */

+ 3 - 3
src/View/Helper/FormHelper.php

@@ -518,13 +518,13 @@ class FormHelper extends Helper
      * Generates a hidden field with a security hash based on the fields used in
      * the form.
      *
-     * If $secureAttributes is set, these html attributes will be merged into
+     * If $secureAttributes is set, these HTML attributes will be merged into
      * the hidden input tags generated for the Security Component. This is
      * especially useful to set HTML5 attributes like 'form'.
      *
      * @param array $fields If set specifies the list of fields to use when
      *    generating the hash, else $this->fields is being used.
-     * @param array $secureAttributes will be passed as html attributes into the hidden
+     * @param array $secureAttributes will be passed as HTML attributes into the hidden
      *    input elements generated for the Security Component.
      * @return string A hidden input field with a security hash
      */
@@ -929,7 +929,7 @@ class FormHelper extends Helper
      * See each field type method for more information. Any options that are part of
      * $attributes or $options for the different **type** methods can be included in `$options` for input().
      * Additionally, any unknown keys that are not in the list below, or part of the selected type's options
-     * will be treated as a regular html attribute for the generated input.
+     * will be treated as a regular HTML attribute for the generated input.
      *
      * - `type` - Force the type of widget you want. e.g. `type => 'select'`
      * - `label` - Either a string label, or an array of options for the label. See FormHelper::label().

+ 2 - 2
src/View/Helper/HtmlHelper.php

@@ -679,10 +679,10 @@ class HtmlHelper extends Helper
      * - `firstClass` Class for wrapper tag on the first breadcrumb, defaults to 'first'
      * - `lastClass` Class for wrapper tag on current active page, defaults to 'last'
      *
-     * @param array $options Array of html attributes to apply to the generated list elements.
+     * @param array $options Array of HTML attributes to apply to the generated list elements.
      * @param string|array|bool $startText This will be the first crumb, if false it defaults to first crumb in array. Can
      *   also be an array, see `HtmlHelper::getCrumbs` for details.
-     * @return string|null breadcrumbs html list
+     * @return string|null Breadcrumbs HTML list.
      * @link http://book.cakephp.org/3.0/en/views/helpers/html.html#creating-breadcrumb-trails-with-htmlhelper
      */
     public function getCrumbList(array $options = [], $startText = false)

+ 3 - 3
src/View/Helper/TextHelper.php

@@ -241,7 +241,7 @@ class TextHelper extends Helper
      *
      * @param string $text Text to search the phrase in
      * @param string $phrase The phrase that will be searched
-     * @param array $options An array of html attributes and options.
+     * @param array $options An array of HTML attributes and options.
      * @return string The highlighted text
      * @see \Cake\Utility\Text::highlight()
      * @link http://book.cakephp.org/3.0/en/views/helpers/text.html#highlighting-substrings
@@ -302,7 +302,7 @@ class TextHelper extends Helper
      *
      * @param string $text String to truncate.
      * @param int $length Length of returned string, including ellipsis.
-     * @param array $options An array of html attributes and options.
+     * @param array $options An array of HTML attributes and options.
      * @return string Trimmed string.
      * @see \Cake\Utility\Text::truncate()
      * @link http://book.cakephp.org/3.0/en/views/helpers/text.html#truncating-text
@@ -325,7 +325,7 @@ class TextHelper extends Helper
      *
      * @param string $text String to truncate.
      * @param int $length Length of returned string, including ellipsis.
-     * @param array $options An array of html attributes and options.
+     * @param array $options An array of HTML attributes and options.
      * @return string Trimmed string.
      * @see \Cake\Utility\Text::tail()
      * @link http://book.cakephp.org/3.0/en/views/helpers/text.html#truncating-the-tail-of-a-string

+ 1 - 1
src/View/StringTemplate.php

@@ -230,7 +230,7 @@ class StringTemplate
      * If the value is not one of these 4, the parameter is not output.
      *
      * 'escape' is a special option in that it controls the conversion of
-     * attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
+     * attributes to their HTML-entity encoded equivalents. Set to false to disable HTML-encoding.
      *
      * If value for any option key is set to `null` or `false`, that option will be excluded from output.
      *