Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add replaceable tags to constants #4028

Merged
merged 1 commit into from
Nov 9, 2024
Merged

Add replaceable tags to constants #4028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion appendices/migration70/changed-functions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<listitem>
<simpara>
<function>setlocale</function> function no longer accepts <parameter>category</parameter>
passed as string. <constant>LC_*</constant> constants must be used instead.
passed as string. <constant>LC_<replaceable>*</replaceable></constant> constants must be used instead.
</simpara>
</listitem>
<listitem>
Expand Down
2 changes: 1 addition & 1 deletion appendices/migration70/incompatible/removed-functions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<function>mcrypt_cbc</function>, <function>mcrypt_cfb</function> and
<function>mcrypt_ofb</function> functions have been removed in favour of
using <function>mcrypt_decrypt</function> with the appropriate
<constant>MCRYPT_MODE_*</constant> constant.
<constant>MCRYPT_MODE_<replaceable>*</replaceable></constant> constant.
</para>
</sect3>

Expand Down
2 changes: 1 addition & 1 deletion appendices/migration80/other-changes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
<methodname>ZipArchive::addEmptyDir</methodname>, <methodname>ZipArchive::addFile</methodname>
and <methodname>ZipArchive::addFromString</methodname>
methods have a new <parameter>flags</parameter> argument. This allows managing name encoding
(<constant>ZipArchive::FL_ENC_*</constant>) and entry replacement
(<constant>ZipArchive::FL_ENC_<replaceable>*</replaceable></constant>) and entry replacement
(<constant>ZipArchive::FL_OVERWRITE</constant>).
</para>
</listitem>
Expand Down
2 changes: 1 addition & 1 deletion language-snippets.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1416,7 +1416,7 @@ encoding value will be used.</para>'>
<!ENTITY memcached.result.delete-multi '<para xmlns="http://docbook.org/ns/docbook">
Returns an array indexed by <parameter>keys</parameter>. Each element
is &true; if the corresponding key was deleted, or one of the
<constant>Memcached::RES_*</constant> constants if the corresponding deletion
<constant>Memcached::RES_<replaceable>*</replaceable></constant> constants if the corresponding deletion
failed.
</para>
<para xmlns="http://docbook.org/ns/docbook">
Expand Down
2 changes: 1 addition & 1 deletion reference/curl/functions/curl-multi-info-read.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
</row>
<row>
<entry><literal>result</literal></entry>
<entry>One of the <constant>CURLE_*</constant> constants. If everything is
<entry>One of the <constant>CURLE_<replaceable>*</replaceable></constant> constants. If everything is
OK, the <constant>CURLE_OK</constant> will be the result.</entry>
</row>
<row>
Expand Down
2 changes: 1 addition & 1 deletion reference/curl/functions/curl-pause.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
One of <constant>CURLPAUSE_*</constant> constants.
One of <constant>CURLPAUSE_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/image/functions/imageaffinematrixget.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<term><parameter>type</parameter></term>
<listitem>
<para>
One of the <constant>IMG_AFFINE_*</constant> constants.
One of the <constant>IMG_AFFINE_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/image/functions/imageflip.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<term><parameter>mode</parameter></term>
<listitem>
<para>
Flip mode, this can be one of the <constant>IMG_FLIP_*</constant> constants:
Flip mode, this can be one of the <constant>IMG_FLIP_<replaceable>*</replaceable></constant> constants:
</para>
<para>
<informaltable>
Expand Down
2 changes: 1 addition & 1 deletion reference/imagick/imagick/getimageinterpolatemethod.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</methodsynopsis>
<para>
Returns the interpolation method for the specified image. The method is one of
the <constant>Imagick::INTERPOLATE_*</constant> constants.
the <constant>Imagick::INTERPOLATE_<replaceable>*</replaceable></constant> constants.
</para>
</refsect1>

Expand Down
2 changes: 1 addition & 1 deletion reference/imagick/imagick/mergeimagelayers.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<term><parameter>layer_method</parameter></term>
<listitem>
<para>
One of the <constant>Imagick::LAYERMETHOD_*</constant> constants
One of the <constant>Imagick::LAYERMETHOD_<replaceable>*</replaceable></constant> constants
</para>
</listitem>
</varlistentry>
Expand Down
4 changes: 2 additions & 2 deletions reference/imagick/imagick/setimagealphachannel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</methodsynopsis>
<para>
Activate or deactivate image alpha channel. The <parameter>mode</parameter>
is one of the <constant>Imagick::ALPHACHANNEL_*</constant> constants.
is one of the <constant>Imagick::ALPHACHANNEL_<replaceable>*</replaceable></constant> constants.
&imagick.method.available.0x638;
</para>
</refsect1>
Expand All @@ -27,7 +27,7 @@
<term><parameter>mode</parameter></term>
<listitem>
<para>
One of the <constant>Imagick::ALPHACHANNEL_*</constant> constants
One of the <constant>Imagick::ALPHACHANNEL_<replaceable>*</replaceable></constant> constants
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/imagick/imagick/setimageinterpolatemethod.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<term><parameter>method</parameter></term>
<listitem>
<para>
The method is one of the <constant>Imagick::INTERPOLATE_*</constant> constants
The method is one of the <constant>Imagick::INTERPOLATE_<replaceable>*</replaceable></constant> constants
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/memcached/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
<term><constant>Memcached::OPT_HASH</constant></term>
<listitem>
<para>Specifies the hashing algorithm used for the item keys. The valid
values are supplied via <constant>Memcached::HASH_*</constant> constants.
values are supplied via <constant>Memcached::HASH_<replaceable>*</replaceable></constant> constants.
Each hash algorithm has its advantages and its disadvantages. Go with the
default if you don't know or don't care.</para>
<para>Type: &integer;, default: <constant>Memcached::HASH_DEFAULT</constant></para>
Expand Down
2 changes: 1 addition & 1 deletion reference/memcached/memcached/getresultcode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</methodsynopsis>
<para>
<function>Memcached::getResultCode</function> returns one of the
<constant>Memcached::RES_*</constant> constants that is the result of the
<constant>Memcached::RES_<replaceable>*</replaceable></constant> constants that is the result of the
last executed Memcached method.
</para>
</refsect1>
Expand Down
2 changes: 1 addition & 1 deletion reference/mysqli/mysqli/commit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of <constant>MYSQLI_TRANS_COR_*</constant> constants.
A bitmask of <constant>MYSQLI_TRANS_COR_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/mysqli/mysqli/rollback.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of <constant>MYSQLI_TRANS_COR_*</constant> constants.
A bitmask of <constant>MYSQLI_TRANS_COR_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
4 changes: 2 additions & 2 deletions reference/oauth/oauth/fetch.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@
<term><parameter>http_method</parameter></term>
<listitem>
<para>
One of the <constant>OAUTH_HTTP_METHOD_*</constant>
<link linkend="oauth.constants">OAUTH constants</link>, which includes
One of the <constant>OAUTH_HTTP_METHOD_<replaceable>*</replaceable></constant>
OAUTH constants, which includes
GET, POST, PUT, HEAD, or DELETE.
</para>
<para>
Expand Down
4 changes: 2 additions & 2 deletions reference/oauth/oauthprovider/checkoauthrequest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@
<term><parameter>method</parameter></term>
<listitem>
<para>
The <acronym>HTTP</acronym> method. Optionally pass in one of the
<constant>OAUTH_HTTP_METHOD_*</constant> <link linkend="oauth.constants">OAuth constants</link>.
haszi marked this conversation as resolved.
Show resolved Hide resolved
The <acronym>HTTP</acronym> method. Optionally pass in one of the
<constant>OAUTH_HTTP_METHOD_<replaceable>*</replaceable></constant> OAuth constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/pdo_pgsql/PDO/pgsqlGetNotify.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<listitem>
<para>
The format the result set should be returned as, represented as a
<link linkend="pdostatement.fetch"><constant>PDO::FETCH_*</constant></link>
Girgias marked this conversation as resolved.
Show resolved Hide resolved
<constant>PDO::FETCH_<replaceable>*</replaceable></constant>
constant.
</para>
</listitem>
Expand Down
2 changes: 1 addition & 1 deletion reference/phpdbg/functions/phpdbg-color.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<term><parameter>element</parameter></term>
<listitem>
<para>
One of the <constant>PHPDBG_COLOR_*</constant> constants.
One of the <constant>PHPDBG_COLOR_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/rnp/functions/rnp-dump-packets-to-json.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
See <constant>RNP_JSON_DUMP_*</constant> predefined constants.
See <constant>RNP_JSON_DUMP_<replaceable>*</replaceable></constant> predefined constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/rnp/functions/rnp-dump-packets.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
See <constant>RNP_DUMP_*</constant> predefined constants.
See <constant>RNP_DUMP_<replaceable>*</replaceable></constant> predefined constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/rnp/functions/rnp-import-keys.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
See <constant>RNP_LOAD_SAVE_*</constant> predefined constants.
See <constant>RNP_LOAD_SAVE_<replaceable>*</replaceable></constant> predefined constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/rnp/functions/rnp-key-export.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
See <constant>RNP_KEY_EXPORT_*</constant> predefined constants
See <constant>RNP_KEY_EXPORT_<replaceable>*</replaceable></constant> predefined constants
(except <constant>RNP_KEY_EXPORT_BASE64</constant>).
</para>
</listitem>
Expand Down
2 changes: 1 addition & 1 deletion reference/rnp/functions/rnp-key-remove.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
See <constant>RNP_KEY_REMOVE_*</constant> constants. Flag <constant>RNP_KEY_REMOVE_SUBKEYS</constant> will work only for
See <constant>RNP_KEY_REMOVE_<replaceable>*</replaceable></constant> constants. Flag <constant>RNP_KEY_REMOVE_SUBKEYS</constant> will work only for
the primary key and will remove all of its subkeys as well.
</para>
</listitem>
Expand Down
2 changes: 1 addition & 1 deletion reference/runkit7/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<listitem>
<simpara>
<function>runkit7_import</function> flag representing
a bitwise OR of the <constant>RUNKIT7_IMPORT_CLASS_*</constant>
a bitwise OR of the <constant>RUNKIT7_IMPORT_CLASS_<replaceable>*</replaceable></constant>
constants.
</simpara>
</listitem>
Expand Down
2 changes: 1 addition & 1 deletion reference/runkit7/functions/runkit7-constant-add.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<listitem>
<para>
Visibility of the constant, for class constants. Public by default.
One of the <constant>RUNKIT7_ACC_*</constant> constants.
One of the <constant>RUNKIT7_ACC_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/runkit7/functions/runkit7-constant-redefine.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<para>
The new visibility of the constant, for class constants.
Unchanged by default.
One of the <constant>RUNKIT7_ACC_*</constant> constants.
One of the <constant>RUNKIT7_ACC_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/snmp/snmp.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@
<listitem>
<para>
Controls which failures will raise SNMPException instead of
warning. Use bitwise OR'ed <constant>SNMP::ERRNO_*</constant> constants.
warning. Use bitwise OR'ed <constant>SNMP::ERRNO_<replaceable>*</replaceable></constant> constants.
By default all SNMP exceptions are disabled.
</para>
</listitem>
Expand Down
4 changes: 2 additions & 2 deletions reference/stream/functions/stream-notification-callback.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@
<term><parameter>notification_code</parameter></term>
<listitem>
<para>
One of the <constant>STREAM_NOTIFY_*</constant> notification constants.
One of the <constant>STREAM_NOTIFY_<replaceable>*</replaceable></constant> notification constants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>severity</parameter></term>
<listitem>
<para>
One of the <constant>STREAM_NOTIFY_SEVERITY_*</constant> notification constants.
One of the <constant>STREAM_NOTIFY_SEVERITY_<replaceable>*</replaceable></constant> notification constants.
</para>
</listitem>
</varlistentry>
Expand Down
8 changes: 4 additions & 4 deletions reference/zip/ziparchive/addglob.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@
<literal>"comp_method"</literal>
</para>
<para>
Compression method, one of the <constant>ZipArchive::CM_*</constant>
constants, see <link linkend="zip.constants">ZIP constants</link> page.
Compression method, one of the <constant>ZipArchive::CM_<replaceable>*</replaceable></constant>
constants.
</para>
</listitem>
<listitem>
Expand All @@ -109,8 +109,8 @@
<literal>"enc_method"</literal>
</para>
<para>
Encryption method, one of the <constant>ZipArchive::EM_*</constant>
constants, see <link linkend="zip.constants">ZIP constants</link> page.
Encryption method, one of the <constant>ZipArchive::EM_<replaceable>*</replaceable></constant>
constants.
</para>
</listitem>
<listitem>
Expand Down
2 changes: 1 addition & 1 deletion reference/zip/ziparchive/iscompressionmethoddupported.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<listitem>
<para>
The compression method, one of the
<constant>ZipArchive::CM_*</constant> constants.
<constant>ZipArchive::CM_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/zip/ziparchive/isencryptionmethoddupported.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<listitem>
<para>
The encryption method, one of the
<constant>ZipArchive::EM_*</constant> constants.
<constant>ZipArchive::EM_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/zip/ziparchive/setcompressionindex.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<listitem>
<para>
The compression method, one of the
<constant>ZipArchive::CM_*</constant> constants.
<constant>ZipArchive::CM_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/zip/ziparchive/setcompressionname.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<listitem>
<para>
The compression method, one of the
<constant>ZipArchive::CM_*</constant> constants.
<constant>ZipArchive::CM_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/zlib/functions/deflate_init.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<term><parameter>encoding</parameter></term>
<listitem>
<para>
One of the <constant>ZLIB_ENCODING_*</constant> constants.
One of the <constant>ZLIB_ENCODING_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/zlib/functions/gzcompress.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
<term><parameter>encoding</parameter></term>
<listitem>
<para>
One of <constant>ZLIB_ENCODING_*</constant> constants.
One of <constant>ZLIB_ENCODING_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/zlib/functions/gzdeflate.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
<term><parameter>encoding</parameter></term>
<listitem>
<para>
One of <constant>ZLIB_ENCODING_*</constant> constants.
One of <constant>ZLIB_ENCODING_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/zlib/functions/inflate_init.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<term><parameter>encoding</parameter></term>
<listitem>
<para>
One of the <constant>ZLIB_ENCODING_*</constant> constants.
One of the <constant>ZLIB_ENCODING_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion reference/zmq/zmqcontext/getopt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<listitem>
<para>
An integer representing the option.
See the <constant>ZMQ::CTXOPT_*</constant> constants.
See the <constant>ZMQ::CTXOPT_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
Expand Down
Loading