1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-24 07:42:10 +01:00

Tidied up refpurposes.

This commit is contained in:
Danack
2023-01-06 14:58:16 +00:00
parent 85278ca11d
commit 1534707f67
10 changed files with 15 additions and 15 deletions

View File

@@ -4,7 +4,7 @@
<refentry xml:id="imagick.getregistry" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Imagick::getRegistry</refname>
<refpurpose>Get the StringRegistry entry for the named key or false if not set</refpurpose>
<refpurpose>Get a StringRegistry entry</refpurpose>
</refnamediv>
<refsect1 role="description">

View File

@@ -4,7 +4,7 @@
<refentry xml:id="imagick.identifyformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Imagick::identifyFormat</refname>
<refpurpose>Replaces any embedded formatting characters with the appropriate image property and returns the interpreted text</refpurpose>
<refpurpose>Formats a string with image details</refpurpose>
</refnamediv>
<refsect1 role="description">

View File

@@ -4,7 +4,7 @@
<refentry xml:id="imagick.setimageattribute" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Imagick::setImageAttribute</refname>
<refpurpose>Sets the image attribute</refpurpose>
<refpurpose>Sets an image attribute</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -19,7 +19,7 @@
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Sets the image attribute
Sets an image attribute.
</para>
</refsect1>

View File

@@ -18,7 +18,7 @@
<methodparam><type>float</type><parameter>bias</parameter></methodparam>
</methodsynopsis>
<para>
Sets the image bias. Bias should be scaled with 0 = no adjustment, 1 = quantum value.
Sets the image bias. Bias should be scaled with <literal>0</literal> (no adjustment) to <literal>1</literal> (quantum value).
</para>
</refsect1>

View File

@@ -4,7 +4,7 @@
<refentry xml:id="imagick.setprogressmonitor" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Imagick::setProgressMonitor</refname>
<refpurpose>Set a callback that will be called during the processing of the Imagick image.</refpurpose>
<refpurpose>Set a callback to be called during processing</refpurpose>
</refnamediv>
<refsect1 role="description">

View File

@@ -4,7 +4,7 @@
<refentry xml:id="imagickkernel.addkernel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImagickKernel::addKernel</refname>
<refpurpose>Attach another kernel to this kernel to allow them to both be applied in a single morphology or filter function</refpurpose>
<refpurpose>Attach another kernel to a kernel list</refpurpose>
</refnamediv>
<refsect1 role="description">

View File

@@ -4,7 +4,7 @@
<refentry xml:id="imagickkernel.addunitykernel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImagickKernel::addUnityKernel</refname>
<refpurpose>Adds a given amount of the 'Unity' Convolution Kernel to the given pre-scaled and normalized Kernel</refpurpose>
<refpurpose>Adds a Unity Kernel to the kernel list</refpurpose>
</refnamediv>
<refsect1 role="description">

View File

@@ -4,7 +4,7 @@
<refentry xml:id="imagickkernel.frommatrix" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImagickKernel::fromMatrix</refname>
<refpurpose>Create a kernel from an 2d matrix of values</refpurpose>
<refpurpose>Create a kernel from a 2d matrix of values</refpurpose>
</refnamediv>
<refsect1 role="description">

View File

@@ -4,7 +4,7 @@
<refentry xml:id="imagickkernel.scale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImagickKernel::scale</refname>
<refpurpose>Scales the given kernel list by the given amount, with or without normalization of the sum of the kernel values (as per given flags).</refpurpose>
<refpurpose>Scales a kernel list by the given amount</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -41,10 +41,10 @@
<term><parameter>normalizeFlag</parameter></term>
<listitem>
<para>
Imagick::NORMALIZE_KERNEL_NONE = 0
Imagick::NORMALIZE_KERNEL_VALUE = 8192
Imagick::NORMALIZE_KERNEL_CORRELATE = 65536
Imagick::NORMALIZE_KERNEL_PERCENT = 4096
Imagick::NORMALIZE_KERNEL_NONE
Imagick::NORMALIZE_KERNEL_VALUE
Imagick::NORMALIZE_KERNEL_CORRELATE
Imagick::NORMALIZE_KERNEL_PERCENT
</para>
</listitem>
</varlistentry>

View File

@@ -4,7 +4,7 @@
<refentry xml:id="imagickpixel.ispixelsimilarquantum" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImagickPixel::isPixelSimilarQuantum</refname>
<refpurpose>Returns true if the distance between two colors is less than the specified distance</refpurpose>
<refpurpose>Returns whether two colors differ by less than the specified distance</refpurpose>
</refnamediv>
<refsect1 role="description">