[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] [doc-en] master: Fix parameter names and markup of grapheme_*() functions
From: "Christoph M. Becker" <noreply () php ! net>
Date: 2022-06-24 15:16:22
Message-ID: KPiV3V1bF0PVDj1fckgKhVRfxDvyqw1fCcjqVhbrbM () main ! php ! net
[Download RAW message or body]
Author: Christoph M. Becker (cmb69)
Date: 2022-06-24T17:10:13+02:00
Commit: https://github.com/php/doc-en/commit/d25989728702c2f55c4666840d07683ed73ae24d
Raw diff: https://github.com/php/doc-en/commit/d25989728702c2f55c4666840d07683ed73ae24d.diff
Fix parameter names and markup of grapheme_*() functions
Changed paths:
M reference/intl/grapheme/grapheme-extract.xml
M reference/intl/grapheme/grapheme-stripos.xml
M reference/intl/grapheme/grapheme-stristr.xml
M reference/intl/grapheme/grapheme-strpos.xml
M reference/intl/grapheme/grapheme-strripos.xml
M reference/intl/grapheme/grapheme-strrpos.xml
M reference/intl/grapheme/grapheme-strstr.xml
M reference/intl/grapheme/grapheme-substr.xml
Diff:
diff --git a/reference/intl/grapheme/grapheme-extract.xml \
b/reference/intl/grapheme/grapheme-extract.xml index 5724eccda88..c295a6c7a56 100644
--- a/reference/intl/grapheme/grapheme-extract.xml
+++ b/reference/intl/grapheme/grapheme-extract.xml
@@ -37,7 +37,7 @@
<term><parameter>size</parameter></term>
<listitem>
<para>
- Maximum number items - based on the $extract_type - to return.
+ Maximum number items - based on the <parameter>type</parameter> - to return.
</para>
</listitem>
</varlistentry>
@@ -45,15 +45,15 @@
<term><parameter>type</parameter></term>
<listitem>
<para>
- Defines the type of units referred to by the $size parameter:
+ Defines the type of units referred to by the <parameter>size</parameter> \
parameter: </para>
<para>
<simplelist>
- <member>GRAPHEME_EXTR_COUNT (default) - $size is the number of default
+ <member>GRAPHEME_EXTR_COUNT (default) -<parameter>size</parameter> is the \
number of default grapheme clusters to extract.</member>
- <member>GRAPHEME_EXTR_MAXBYTES - $size is the maximum number of bytes
+ <member>GRAPHEME_EXTR_MAXBYTES -<parameter>size</parameter> is the maximum \
number of bytes returned.</member>
- <member>GRAPHEME_EXTR_MAXCHARS - $size is the maximum number of UTF-8
+ <member>GRAPHEME_EXTR_MAXCHARS - <parameter>size</parameter> is the maximum \
number of UTF-8 characters returned.</member>
</simplelist>
</para>
@@ -63,10 +63,10 @@
<term><parameter>offset</parameter></term>
<listitem>
<para>
- Starting position in $haystack in bytes - if given, it must be zero or a
- positive value that is less than or equal to the length of $haystack in
- bytes, or a negative value that counts from the end of $haystack.
- If $start does not point to the first byte of a UTF-8
+ Starting position in<parameter>haystack</parameter> in bytes - if given, it \
must be zero or a + positive value that is less than or equal to the length of \
<parameter>haystack</parameter> in + bytes, or a negative value that counts \
from the end of <parameter>haystack</parameter>. + If \
<parameter>offset</parameter> does not point to the first byte of a \
UTF-8
character, the start position is moved to the next character boundary.
</para>
</listitem>
@@ -89,8 +89,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- A string starting at offset $start and ending on a default grapheme cluster
- boundary that conforms to the $size and $extract_type specified,
+ A string starting at offset <parameter>offset</parameter> and ending on a default \
grapheme cluster + boundary that conforms to the <parameter>size</parameter> and \
<parameter>type</parameter> specified, &return.falseforfailure;.
</para>
</refsect1>
diff --git a/reference/intl/grapheme/grapheme-stripos.xml \
b/reference/intl/grapheme/grapheme-stripos.xml index 2aa57a2883b..8602db5ad68 100644
--- a/reference/intl/grapheme/grapheme-stripos.xml
+++ b/reference/intl/grapheme/grapheme-stripos.xml
@@ -43,11 +43,11 @@
<term><parameter>offset</parameter></term>
<listitem>
<para>
- The optional $offset parameter allows you to specify where in haystack to
+ The optional <parameter>offset</parameter> parameter allows you to specify \
where in haystack to
start searching as an offset in grapheme units (not bytes or characters).
If the offset is negative, it is treated relative to the end of the string.
The position returned is still relative to the beginning of haystack
- regardless of the value of $offset.
+ regardless of the value of <parameter>offset</parameter>.
</para>
</listitem>
</varlistentry>
@@ -59,7 +59,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the position as an integer. If needle is not found, grapheme_stripos() \
will return &false;. + Returns the position as an integer. If \
<parameter>needle</parameter> is not found, <function>grapheme_stripos</function> \
will return &false;. </para>
</refsect1>
diff --git a/reference/intl/grapheme/grapheme-stristr.xml \
b/reference/intl/grapheme/grapheme-stristr.xml index 2666f26e502..cdd0c2c27f1 100644
--- a/reference/intl/grapheme/grapheme-stristr.xml
+++ b/reference/intl/grapheme/grapheme-stristr.xml
@@ -44,7 +44,7 @@
<listitem>
<para>
If &true;, grapheme_strstr() returns the part of the
- haystack before the first occurrence of the needle (excluding needle).
+ <parameter>haystack</parameter> before the first occurrence of the needle \
(excluding needle). </para>
</listitem>
</varlistentry>
@@ -56,7 +56,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the portion of $haystack, or &false; if $needle is not found.
+ Returns the portion of <parameter>haystack</parameter>, or &false; if \
<parameter>needle</parameter> is not found. </para>
</refsect1>
diff --git a/reference/intl/grapheme/grapheme-strpos.xml \
b/reference/intl/grapheme/grapheme-strpos.xml index 436ab6ab390..d1e04255931 100644
--- a/reference/intl/grapheme/grapheme-strpos.xml
+++ b/reference/intl/grapheme/grapheme-strpos.xml
@@ -43,11 +43,11 @@
<term><parameter>offset</parameter></term>
<listitem>
<para>
- The optional $offset parameter allows you to specify where in $haystack to
+ The optional <parameter>offset</parameter> parameter allows you to specify \
where in <parameter>haystack</parameter> to
start searching as an offset in grapheme units (not bytes or characters).
If the offset is negative, it is treated relative to the end of the string.
The position returned is still relative to the beginning of haystack
- regardless of the value of $offset.
+ regardless of the value of <parameter>offset</parameter>.
</para>
</listitem>
</varlistentry>
@@ -59,7 +59,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the position as an integer. If needle is not found, grapheme_strpos() \
will return &false;. + Returns the position as an integer. If \
<parameter>needle</parameter> is not found, <function>grapheme_strpos</function> will \
return &false;. </para>
</refsect1>
diff --git a/reference/intl/grapheme/grapheme-strripos.xml \
b/reference/intl/grapheme/grapheme-strripos.xml index 7957257de44..ab0a7f6014b 100644
--- a/reference/intl/grapheme/grapheme-strripos.xml
+++ b/reference/intl/grapheme/grapheme-strripos.xml
@@ -43,10 +43,10 @@
<term><parameter>offset</parameter></term>
<listitem>
<para>
- The optional $offset parameter allows you to specify where in $haystack to
+ The optional <parameter>offset</parameter> parameter allows you to specify \
where in<parameter>haystack</parameter> to
start searching as an offset in grapheme units (not bytes or characters).
- The position returned is still relative to the beginning of haystack
- regardless of the value of $offset.
+ The position returned is still relative to the beginning of \
<parameter>haystack</parameter> + regardless of the value \
of<parameter>offset</parameter>. </para>
</listitem>
</varlistentry>
@@ -58,7 +58,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the position as an integer. If needle is not found, grapheme_strripos() \
will return &false;. + Returns the position as an integer. If \
<parameter>needle</parameter> is not found, <function>grapheme_strripos</function> \
will return &false;. </para>
</refsect1>
diff --git a/reference/intl/grapheme/grapheme-strrpos.xml \
b/reference/intl/grapheme/grapheme-strrpos.xml index 1ef8a1769c7..0777ed83b0d 100644
--- a/reference/intl/grapheme/grapheme-strrpos.xml
+++ b/reference/intl/grapheme/grapheme-strrpos.xml
@@ -43,10 +43,10 @@
<term><parameter>offset</parameter></term>
<listitem>
<para>
- The optional $offset parameter allows you to specify where in $haystack to
+ The optional<parameter>offset</parameter> parameter allows you to specify \
where in <parameter>haystack</parameter> to
start searching as an offset in grapheme units (not bytes or characters).
- The position returned is still relative to the beginning of haystack
- regardless of the value of $offset.
+ The position returned is still relative to the beginning of \
<parameter>haystack</parameter> + regardless of the value of \
<parameter>offset</parameter>. </para>
</listitem>
</varlistentry>
@@ -58,7 +58,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the position as an integer. If needle is not found, grapheme_strrpos() \
will return &false;. + Returns the position as an integer. If \
<parameter>needle</parameter> is not found, <function>grapheme_strrpos</function> \
will return &false;. </para>
</refsect1>
diff --git a/reference/intl/grapheme/grapheme-strstr.xml \
b/reference/intl/grapheme/grapheme-strstr.xml index b0f04f8629e..8c2b2e53140 100644
--- a/reference/intl/grapheme/grapheme-strstr.xml
+++ b/reference/intl/grapheme/grapheme-strstr.xml
@@ -43,8 +43,8 @@
<term><parameter>beforeNeedle</parameter></term>
<listitem>
<para>
- If &true;, grapheme_strstr() returns the part of the
- haystack before the first occurrence of the needle (excluding the needle).
+ If &true;, <function>grapheme_strstr</function> returns the part of the
+ <parameter>haystack</parameter> before the first occurrence of the \
<parameter>needle</parameter> (excluding the <parameter>needle</parameter>). </para>
</listitem>
</varlistentry>
@@ -56,7 +56,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the portion of string, or &false; if needle is not found.
+ Returns the portion of <parameter>haystack</parameter>, or &false; if \
<parameter>needle</parameter> is not found. </para>
</refsect1>
diff --git a/reference/intl/grapheme/grapheme-substr.xml \
b/reference/intl/grapheme/grapheme-substr.xml index 7e00b8aead7..e8c247d737f 100644
--- a/reference/intl/grapheme/grapheme-substr.xml
+++ b/reference/intl/grapheme/grapheme-substr.xml
@@ -36,9 +36,9 @@
<listitem>
<para>
Start position in default grapheme units.
- If $start is non-negative, the returned string will start at the
- $start'th position in $string, counting from zero. If $start is negative,
- the returned string will start at the $start'th grapheme unit from the
+ If <parameter>offset</parameter> is non-negative, the returned string will \
start at the + <parameter>offset</parameter>'th position in \
<parameter>string</parameter>, counting from zero. If <parameter>offset</parameter> \
is negative, + the returned string will start at the \
<parameter>offset</parameter>'th grapheme unit from the end of string.
</para>
</listitem>
@@ -48,12 +48,12 @@
<listitem>
<para>
Length in grapheme units.
- If $length is given and is positive, the string returned will contain
- at most $length grapheme units beginning from $start (depending on the
- length of string). If $length is given and is negative, then
+ If <parameter>length</parameter> is given and is positive, the string \
returned will contain + at most <parameter>length</parameter> grapheme units \
beginning from <parameter>offset</parameter> (depending on the + length of \
string). If <parameter>length</parameter> is given and is negative, \
then
that many grapheme units will be omitted from the end of string (after the
- start position has been calculated when a start is negative). If $start
- denotes a position beyond this truncation, &false; will be returned.
+ start position has been calculated when <parameter>offset</parameter> is \
negative). If <parameter>offset</parameter> + denotes a position beyond this \
truncation, &false; will be returned. </para>
</listitem>
</varlistentry>
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic