Briefly document GMagick::setCompressionQuality

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338514 c90b9560-bf6c-de11-be94-00142212c4b1

reference/gmagick/gmagick/setcompressionquality.xml

@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="gmagick.setcompressionquality" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Gmagick::setCompressionQuality</refname>
+  <refpurpose>Sets the object's default compression quality</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="oop">
+   <type>bool</type><methodname>Gmagick::setCompressionQuality</methodname>
+   <methodparam>
+    <type>int</type><parameter>quality</parameter>
+    <initializer>75</initializer>
+   </methodparam>
+  </methodsynopsis>
+  <para>
+   Sets the object's default compression quality.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>quality</parameter></term>
+     <listitem>
+      <para>
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The Gmagick object on success
+  </para>
+ </refsect1>
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   &gmagick.gmagickexception.throw;
+  </para>
+ </refsect1>
+
+<!-- Not sure if the ChangeLog entries are useful
+     in this case or not, so leaving the block
+     commented out.
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>Enter the version of change here</entry>
+      <entry>
+       Describe the change
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+-->
+
+
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+    <example>
+      <title> <function>Gmagick::setCompressionQuality</function></title>
+      <programlisting role="php">
+      <![CDATA[
+<?php
+$gm = new Gmagick();
+$gm->read("magick:rose");
+$gm->setCompressionQuality(2);
+?>
+]]>
+      </programlisting>
+    </example>
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->