Skip to content

Commit 8cf0fa1

Browse files
authored
docs: Fix $indexPage param explanations in helpers/html_helper.rst (#9162)
1 parent 695829c commit 8cf0fa1

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

user_guide_src/source/helpers/html_helper.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ The following functions are available:
2828
.. php:function:: img([$src = ''[, $indexPage = false[, $attributes = '']]])
2929
3030
:param string|array $src: Image source URI, or array of attributes and values
31-
:param bool $indexPage: Whether to treat ``$src`` as a routed URI string
31+
:param bool $indexPage: Should ``Config\App::$indexPage`` be added to the source path
3232
:param mixed $attributes: Additional HTML attributes
33-
:returns: HTML image element
33+
:returns: An HTML image element
3434
:rtype: string
3535

3636
Lets you create HTML ``<img>`` elements. The first parameter contains the
@@ -80,14 +80,14 @@ The following functions are available:
8080
:param string $type: Type of the related document
8181
:param string $title: Link title
8282
:param string $media: Media type
83-
:param bool $indexPage: Whether to treat ``$src`` as a routed URI string
83+
:param bool $indexPage: Should indexPage be added to the link path
8484
:param string $hreflang: Hreflang type
8585
:returns: An HTML link element
8686
:rtype: string
8787

8888
Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
8989
as well as other links. The parameters are *href*, with optional *rel*,
90-
*type*, *title*, *media* and *indexPage*.
90+
*type*, *title*, *media*, *indexPage* and *hreflang*.
9191

9292
*indexPage* is a boolean value that specifies if the *href* should have
9393
the page specified by ``$config['indexPage']`` added to the address it creates.
@@ -215,7 +215,7 @@ The following functions are available:
215215
:param string $unsupportedMessage: The message to display if the video element is not supported by the browser
216216
:param string $attributes: HTML attributes
217217
:param array $tracks: Use the track function inside an array. See :php:func:`track()` function
218-
:param bool $indexPage:
218+
:param bool $indexPage: Should indexPage be added to the video source path
219219
:returns: An HTML video element
220220
:rtype: string
221221

@@ -254,7 +254,7 @@ The following functions are available:
254254
:param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
255255
:param string $attributes:
256256
:param array $tracks: Use the track function inside an array. See :php:func:`track()` function
257-
:param bool $indexPage:
257+
:param bool $indexPage: Should indexPage be added to the audio source path
258258
:returns: An HTML audio element
259259
:rtype: string
260260

@@ -278,7 +278,7 @@ The following functions are available:
278278
:param string $src: The path of the resource to embed
279279
:param bool $type: MIME-type
280280
:param array $attributes: HTML attributes
281-
:param bool $indexPage:
281+
:param bool $indexPage: Should indexPage be added to the source path
282282
:returns: An HTML embed element
283283
:rtype: string
284284

@@ -292,6 +292,7 @@ The following functions are available:
292292
:param string $data: A resource URL
293293
:param bool $type: Content-type of the resource
294294
:param array $attributes: HTML attributes
295+
:param bool $indexPage: Should indexPage be added to the resource URL
295296
:param array $params: Use the param function inside an array. See :php:func:`param()` function
296297
:returns: An HTML object element
297298
:rtype: string

0 commit comments

Comments
 (0)