Skip to content

Commit 1534707

Browse files
committed
Tidied up refpurposes.
1 parent 85278ca commit 1534707

File tree

10 files changed

+15
-15
lines changed

10 files changed

+15
-15
lines changed

reference/imagick/imagick/getregistry.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<refentry xml:id="imagick.getregistry" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>Imagick::getRegistry</refname>
7-
<refpurpose>Get the StringRegistry entry for the named key or false if not set</refpurpose>
7+
<refpurpose>Get a StringRegistry entry</refpurpose>
88
</refnamediv>
99

1010
<refsect1 role="description">

reference/imagick/imagick/identifyformat.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<refentry xml:id="imagick.identifyformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>Imagick::identifyFormat</refname>
7-
<refpurpose>Replaces any embedded formatting characters with the appropriate image property and returns the interpreted text</refpurpose>
7+
<refpurpose>Formats a string with image details</refpurpose>
88
</refnamediv>
99

1010
<refsect1 role="description">

reference/imagick/imagick/setimageattribute.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<refentry xml:id="imagick.setimageattribute" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>Imagick::setImageAttribute</refname>
7-
<refpurpose>Sets the image attribute</refpurpose>
7+
<refpurpose>Sets an image attribute</refpurpose>
88
</refnamediv>
99

1010
<refsynopsisdiv>
@@ -19,7 +19,7 @@
1919
<methodparam><type>string</type><parameter>value</parameter></methodparam>
2020
</methodsynopsis>
2121
<para>
22-
Sets the image attribute
22+
Sets an image attribute.
2323
</para>
2424

2525
</refsect1>

reference/imagick/imagick/setimagebiasquantum.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<methodparam><type>float</type><parameter>bias</parameter></methodparam>
1919
</methodsynopsis>
2020
<para>
21-
Sets the image bias. Bias should be scaled with 0 = no adjustment, 1 = quantum value.
21+
Sets the image bias. Bias should be scaled with <literal>0</literal> (no adjustment) to <literal>1</literal> (quantum value).
2222
</para>
2323

2424
</refsect1>

reference/imagick/imagick/setprogressmonitor.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<refentry xml:id="imagick.setprogressmonitor" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>Imagick::setProgressMonitor</refname>
7-
<refpurpose>Set a callback that will be called during the processing of the Imagick image.</refpurpose>
7+
<refpurpose>Set a callback to be called during processing</refpurpose>
88
</refnamediv>
99

1010
<refsect1 role="description">

reference/imagick/imagickkernel/addkernel.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<refentry xml:id="imagickkernel.addkernel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>ImagickKernel::addKernel</refname>
7-
<refpurpose>Attach another kernel to this kernel to allow them to both be applied in a single morphology or filter function</refpurpose>
7+
<refpurpose>Attach another kernel to a kernel list</refpurpose>
88
</refnamediv>
99

1010
<refsect1 role="description">

reference/imagick/imagickkernel/addunitykernel.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<refentry xml:id="imagickkernel.addunitykernel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>ImagickKernel::addUnityKernel</refname>
7-
<refpurpose>Adds a given amount of the 'Unity' Convolution Kernel to the given pre-scaled and normalized Kernel</refpurpose>
7+
<refpurpose>Adds a Unity Kernel to the kernel list</refpurpose>
88
</refnamediv>
99

1010
<refsect1 role="description">

reference/imagick/imagickkernel/frommatrix.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<refentry xml:id="imagickkernel.frommatrix" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>ImagickKernel::fromMatrix</refname>
7-
<refpurpose>Create a kernel from an 2d matrix of values</refpurpose>
7+
<refpurpose>Create a kernel from a 2d matrix of values</refpurpose>
88
</refnamediv>
99

1010
<refsect1 role="description">

reference/imagick/imagickkernel/scale.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<refentry xml:id="imagickkernel.scale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>ImagickKernel::scale</refname>
7-
<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>
7+
<refpurpose>Scales a kernel list by the given amount</refpurpose>
88
</refnamediv>
99

1010
<refsect1 role="description">
@@ -41,10 +41,10 @@
4141
<term><parameter>normalizeFlag</parameter></term>
4242
<listitem>
4343
<para>
44-
Imagick::NORMALIZE_KERNEL_NONE = 0
45-
Imagick::NORMALIZE_KERNEL_VALUE = 8192
46-
Imagick::NORMALIZE_KERNEL_CORRELATE = 65536
47-
Imagick::NORMALIZE_KERNEL_PERCENT = 4096
44+
Imagick::NORMALIZE_KERNEL_NONE
45+
Imagick::NORMALIZE_KERNEL_VALUE
46+
Imagick::NORMALIZE_KERNEL_CORRELATE
47+
Imagick::NORMALIZE_KERNEL_PERCENT
4848
</para>
4949
</listitem>
5050
</varlistentry>

reference/imagick/imagickpixel/ispixelsimilarquantum.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<refentry xml:id="imagickpixel.ispixelsimilarquantum" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>ImagickPixel::isPixelSimilarQuantum</refname>
7-
<refpurpose>Returns true if the distance between two colors is less than the specified distance</refpurpose>
7+
<refpurpose>Returns whether two colors differ by less than the specified distance</refpurpose>
88
</refnamediv>
99

1010
<refsect1 role="description">

0 commit comments

Comments
 (0)