Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Change "aClass" convention to just "class" in method signatures. Nume…

…rous miscellaneous fixes.
  • Loading branch information...
commit b39952f1dff12c7ed158e86ab095bbec71984838 1 parent d587148
rmagick authored
View
12 doc/comtasks.html
@@ -1,5 +1,5 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
@@ -189,9 +189,11 @@ <h2 id="resizing">Resizing to a maximum (or minimum) size</h2>
value from the block. The <code>change_geometry</code> method
then returns that value to its caller.</p>
- <h3>Simple thumbnails</h3>If you just want to make sure your
- thumbnail is no bigger than a certain width and height, use the
- <a href="image3.html#resize_to_fit">resize_to_fit</a> method.
+ <h3>Simple thumbnails</h3>
+
+ <p>If you just want to make sure your thumbnail is no bigger than
+ a certain width and height, use the <a href=
+ "image3.html#resize_to_fit">resize_to_fit</a> method.</p>
<pre class="example">
thumb = img.resize_to_fit(75, 75)
</pre>
View
12 doc/constants.html
@@ -155,13 +155,13 @@ <h2 class="methods">Constants</h2>
<dd>An extended form of the <code>Version</code> constant with
the format shown here:<br />
- <code>This is RMagick 1.15.0 ($Date: 2007/12/26 21:44:14 $)
- Copyright (C) 2007 by Timothy P. Hunter<br />
- Built with ImageMagick 6.2.5 03/05/06 Q8
+ <code>This is RMagick 2.0.0 ($Date: 2008/01/07 00:03:59 $)
+ Copyright (C) 2008 by Timothy P. Hunter<br />
+ Built with ImageMagick 6.3.7 01/05/08 Q16
http://www.imagemagick.org<br />
- Built for ruby 1.8.0 (2003-08-04) [i686-linux]<br />
+ Built for ruby 1.8.6<br />
Web page: http://rmagick.rubyforge.org<br />
- Email: rmagick@rubyforge.org<br /></code></dd>
+ Email: rmagick@rubyforge.org</code></dd>
<dt>MagickVersion</dt>
@@ -216,7 +216,7 @@ <h2 class="methods">Constants</h2>
<dt>Version</dt>
<dd>The RMagick version string. This has the form:<br />
- <code>RMagick major.minor.teeny</code></dd>
+ <code>RMagick 2.0.0</code></dd>
</dl>
<h3 class="const" id="AlignType">AlignType</h3>
View
224 doc/draw.html
@@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
- "HTML Tidy for Linux/x86 (vers 1st December 2004), see www.w3.org" />
+ "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
<title>RMagick 0.0.0: class Draw</title>
<meta http-equiv="Content-Type" content=
@@ -247,8 +247,8 @@ <h2 class="methods">class methods</h2>
<div class="sig">
<h3 id="new">new</h3>
- <p>Magick::Draw.new <span class="arg">[&nbsp;{ optional
- parameters }&nbsp;]</span> -&gt; <em>draw</em></p>
+ <p>Draw.new <span class="arg">[&nbsp;{ optional parameters
+ }&nbsp;]</span> -&gt; <em>draw</em></p>
</div>
<div class="desc">
@@ -280,7 +280,7 @@ <h3 id="annotate">annotate</h3>
"arg">height</span>, <span class="arg">x</span>, <span class=
"arg">y</span>, <span class="arg">text</span>) <span class=
"arg">[&nbsp;{ additional parameters }&nbsp;]</span> -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -531,7 +531,8 @@ <h3 id="annotate">annotate</h3>
<div class="sig">
<h3 id="clone">clone</h3>
- <p><span class="arg">draw</span>.clone -&gt; <em>aDraw</em></p>
+ <p><span class="arg">draw</span>.clone -&gt;
+ <em>other_draw</em></p>
</div>
<div class="desc">
@@ -549,7 +550,7 @@ <h3 id="clone">clone</h3>
<h3 id="draw">draw</h3>
<p><span class="arg">draw</span>.draw(<span class=
- "arg">img</span>) -&gt; <em>draw</em></p>
+ "arg">img</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -581,7 +582,8 @@ <h3 id="draw">draw</h3>
<div class="sig">
<h3 id="dup">dup</h3>
- <p><span class="arg">draw</span>.dup -&gt; <em>aDraw</em></p>
+ <p><span class="arg">draw</span>.dup -&gt;
+ <em>other_draw</em></p>
</div>
<div class="desc">
@@ -605,16 +607,16 @@ <h3 id="get_multiline_type_metrics">
<p><span class=
"arg">draw</span>.get_multiline_type_metrics([<span class=
- "arg">anImage</span>,] <span class="arg">aString</span>) -&gt;
- <em>aTypeMetric</em></p>
+ "arg">image</span>,] <span class="arg">string</span>) -&gt;
+ <em>type_metrics</em></p>
</div>
<div class="sig">
<h3 id="get_type_metrics">get_type_metrics</h3>
<p><span class="arg">draw</span>.get_type_metrics([<span class=
- "arg">anImage</span>,] <span class="arg">aString</span>) -&gt;
- <em>aTypeMetric</em></p>
+ "arg">image</span>,] <span class="arg">string</span>) -&gt;
+ <em>type_metrics</em></p>
</div>
<div class="desc">
@@ -680,22 +682,21 @@ <h3 id="get_type_metrics">get_type_metrics</h3>
<dt>string</dt>
<dd>The string to be rendered. If <span class=
- "arg">image</span> is specified, the string may contain
- special characters that refer to the image attributes. See
- <a href="#spec_chars_table">this</a> table.</dd>
+ "arg">img</span> is specified, the string may contain special
+ characters that refer to the image attributes. See <a href=
+ "#spec_chars_table">this</a> table.</dd>
</dl>
<h4>Returns</h4>
- <p>A Magick::TypeMetric struct. This structure has the
- following attributes. (The descriptions are taken from the
- <a href=
+ <p>A TypeMetric struct. This structure has the following
+ attributes. (The descriptions are taken from the <a href=
"http://www.imagemagick.org/Magick++/TypeMetric.html">Magick++</a>
documentation and source code.)</p>
<table summary="type metric attributes" class="simple_table">
<caption>
- Magick::TypeMetric attributes
+ TypeMetric attributes
</caption>
<tr>
@@ -767,13 +768,13 @@ <h3 id="get_type_metrics">get_type_metrics</h3>
<h3 id="inspect">inspect</h3>
<p><span class="arg">draw</span>.inspect -&gt;
- <em>draw</em></p>
+ <em>string</em></p>
</div>
<div class="desc">
<h4>Description</h4>
- <p>Displays the list of primitives that have been added to the
+ <p>Returns the list of primitives that have been added to the
<code>draw</code> object. This is very handy for debugging.</p>
<h4>Example</h4>
@@ -795,7 +796,7 @@ <h2 class="methods">drawing primitive methods</h2>
<h3 id="affine">affine</h3>
<p><span class="arg">draw</span>.affine(<span class="arg">sx,
- rx, ry, sy, tx, ty</span>) -&gt; <em>draw</em></p>
+ rx, ry, sy, tx, ty</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -851,7 +852,7 @@ <h3 id="arc">arc</h3>
<p><span class="arg">draw</span>.arc(<span class="arg">start_x,
start_y, end_x, end_y, start_degrees, end_degrees</span>) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -903,7 +904,7 @@ <h3 id="bezier">bezier</h3>
"arg">cx1</span>, <span class="arg">cy1</span>, <span class=
"arg">cx2</span>, <span class="arg">cy2</span>, <span class=
"arg">x2</span>, <span class="arg">y2</span>...) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -989,7 +990,7 @@ <h3 id="circle">circle</h3>
<p><span class="arg">draw</span>.circle(<span class=
"arg">origin_x, origin_y, perim_x, perim_y</span>) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<p>self</p>
@@ -1028,7 +1029,7 @@ <h3 id="circle">circle</h3>
<h3 id="clip_path">clip_path</h3>
<p><span class="arg">draw</span>.clip_path(<span class=
- "arg">pathname</span>) -&gt; <em>draw</em></p>
+ "arg">pathname</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1081,7 +1082,7 @@ <h3 id="clip_rule">clip_rule</h3>
<p><span class=
"arg">draw</span>.clip_rule(<code>"evenodd"</code> or
- <code>"nonzero"</code>) -&gt; <em>draw</em></p>
+ <code>"nonzero"</code>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1109,7 +1110,7 @@ <h3 id="clip_units">clip_units</h3>
<p><span class=
"arg">draw</span>.clip_units(<code>"userSpace"</code>
<span class="arg">or</span> <code>"userSpaceOnUse"</code> or
- <code>"objectSpace"</code>) -&gt; <em>draw</em></p>
+ <code>"objectSpace"</code>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1136,7 +1137,7 @@ <h3 id="color">color</h3>
<p><span class="arg">draw</span>.color(<span class=
"arg">x</span>, <span class="arg">y</span>, <span class=
- "arg">aPaintMethod</span>) -&gt; <em>draw</em></p>
+ "arg">paint_method</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1160,7 +1161,7 @@ <h3 id="color">color</h3>
<h4>Example</h4>
<pre>
draw.border_color = 'black'
- draw.color(x, y, Magick::FillToBorderMethod)
+ draw.color(x, y, FillToBorderMethod)
</pre>
<h4>See Also</h4>
@@ -1175,8 +1176,8 @@ <h3 id="composite">composite</h3>
"arg">x</span>, <span class="arg">y</span>, <span class=
"arg">width</span>, <span class="arg">height</span>,
<span class="arg">composite_image</span>, <span class=
- "arg">op</span>=<code>Magick::OverCompositeOp</code>) -&gt;
- <em>draw</em></p>
+ "arg">op</span>=<code>OverCompositeOp</code>) -&gt;
+ <em>self</em></p>
</div>
<div class="desc">
@@ -1236,7 +1237,7 @@ <h3 id="composite">composite</h3>
<h3 id="decorate">decorate</h3>
<p><span class="arg">draw</span>.decorate(<span class=
- "arg">aDecorationType</span>) -&gt; <em>draw</em></p>
+ "arg">decoration</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1255,7 +1256,7 @@ <h3 id="decorate">decorate</h3>
<h4>Example</h4>
<pre>
-draw.decorate(Magick::LineThroughDecoration)
+draw.decorate(LineThroughDecoration)
</pre>
</div>
@@ -1263,8 +1264,8 @@ <h3 id="decorate">decorate</h3>
<h3 id="define_clip_path">define_clip_path</h3>
<p><span class="arg">draw</span>.define_clip_path(<span class=
- "arg">aString</span>) { <span class="arg">block</span> } -&gt;
- <em>draw</em></p>
+ "arg">string</span>) { <span class="arg">block</span> } -&gt;
+ <em>self</em></p>
</div>
<div class="desc">
@@ -1302,7 +1303,7 @@ <h3 id="ellipse">ellipse</h3>
"arg">origin_y</span>, <span class="arg">width</span>,
<span class="arg">height</span>, <span class=
"arg">arc_start</span>, <span class="arg">arc_end</span>) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -1351,7 +1352,7 @@ <h3 id="ellipse">ellipse</h3>
<h3 id="encoding">encoding</h3>
<p><span class="arg">draw</span>.encoding(<span class=
- "arg">aString</span>) -&gt; <em>draw</em></p>
+ "arg">string</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1374,7 +1375,7 @@ <h3 id="encoding">encoding</h3>
<h3 id="fill">fill</h3>
<p><span class="arg">draw</span>.fill(<span class=
- "arg">aString</span>) -&gt; <em>draw</em></p>
+ "arg">string</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1406,8 +1407,7 @@ <h3 id="fill">fill</h3>
<h3 id="fill_opacity">fill_opacity</h3>
<p><span class="arg">draw</span>.fill_opacity(<span class=
- "arg">aFloat</span> or <em>aString</em>) -&gt;
- <em>draw</em></p>
+ "arg">float</span> or <em>string</em>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1438,7 +1438,7 @@ <h3 id="fill_rule">fill_rule</h3>
<p><span class=
"arg">draw</span>.fill_rule(<code>"evenodd"</code> or
- <code>"nonzero"</code>) -&gt; <em>draw</em></p>
+ <code>"nonzero"</code>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1463,9 +1463,8 @@ <h3 id="fill_rule">fill_rule</h3>
<div class="sig">
<h3 id="font">font</h3>
- <p><span class=
- "arg"><em>draw</em>.font(<em>aString</em>)</span> -&gt;
- <em>draw</em></p>
+ <p><span class="arg">draw</span>.font(<span class=
+ "arg">string</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1496,7 +1495,7 @@ <h3 id="font">font</h3>
<h3 id="font_family">font_family</h3>
<p><span class="arg">draw</span>.font_family(<span class=
- "arg">aString</span>) -&gt; draw</p>
+ "arg">string</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1521,7 +1520,7 @@ <h3 id="font_family">font_family</h3>
<h3 id="font_stretch">font_stretch</h3>
<p><span class="arg">draw</span>.font_stretch(<span class=
- "arg">aStretchType</span>) -&gt; <em>draw</em></p>
+ "arg">stretch</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1543,7 +1542,7 @@ <h3 id="font_stretch">font_stretch</h3>
<h3 id="font_style">font_style</h3>
<p><span class="arg">draw</span>.font_style(<span class=
- "arg">aStyleType</span>) -&gt; <em>draw</em></p>
+ "arg">style</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1565,7 +1564,7 @@ <h3 id="font_style">font_style</h3>
<h3 id="font_weight">font_weight</h3>
<p><span class="arg">draw</span>.font_weight(<span class=
- "arg">aWeightType</span>) -&gt; <em>draw</em></p>
+ "arg">weight</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1589,14 +1588,14 @@ <h3 id="font_weight">font_weight</h3>
<h3 id="gravity">gravity</h3>
<p><span class="arg">draw</span>.gravity(<span class=
- "arg">aGravityType</span>) -&gt; <em>draw</em></p>
+ "arg">gravity</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specify how the text is positioned. The default is
- <code>Magick::NorthWestGravity</code>.</p>
+ <code>NorthWestGravity</code>.</p>
<h4>Arguments</h4>
@@ -1624,7 +1623,7 @@ <h3 id="line">line</h3>
<p><span class="arg">draw</span>.line(<span class=
"arg">here_x</span>, <span class="arg">here_y</span>,
<span class="arg">there_x</span>, <span class=
- "arg">there_y</span>) -&gt; <em>draw</em></p>
+ "arg">there_y</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1664,7 +1663,7 @@ <h3 id="matte">matte</h3>
<p><span class="arg">draw</span>.matte(<span class=
"arg">x</span>,<span class="arg">y</span>, <span class=
- "arg">aPaintMethod</span>) -&gt; <em>draw</em></p>
+ "arg">paint_method</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1681,7 +1680,7 @@ <h3 id="matte">matte</h3>
<dd>Point in image to use, along with the PaintMethod
constant, to set transparent pixels in the image.</dd>
- <dt>aPaintMethod</dt>
+ <dt>paint_method</dt>
<dd>
One of the following <a href=
@@ -1735,7 +1734,7 @@ <h3 id="matte">matte</h3>
<h3 id="opacity">opacity</h3>
<p><span class="arg">draw</span>.opacity(<span class=
- "arg">opacity</span>) -&gt; <em>draw</em></p>
+ "arg">opacity</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1772,7 +1771,7 @@ <h3 id="opacity">opacity</h3>
<h3 id="path">path</h3>
<p><span class="arg">draw</span>.path(<span class=
- "arg">aString</span>) -&gt; <em>draw</em></p>
+ "arg">string</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1835,7 +1834,7 @@ <h3 id="pattern">pattern</h3>
"arg">name</span>, <span class="arg">x</span>, <span class=
"arg">y</span>, <span class="arg">width</span>, <span class=
"arg">height</span>) { pattern primitives } -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -1893,7 +1892,7 @@ <h3 id="point">point</h3>
<p><span class="arg">draw</span>.point(<span class=
"arg">x</span>, <span class="arg">y</span>) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -1919,7 +1918,7 @@ <h3 id="point">point</h3>
<h3 id="pointsize">pointsize</h3>
<p><span class="arg">draw</span>.pointsize(<span class=
- "arg">anInteger</span>) -&gt; <em>draw</em></p>
+ "arg">integer</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1946,7 +1945,7 @@ <h3 id="polygon">polygon</h3>
<p><span class="arg">draw</span>.polygon(<span class=
"arg">x1</span>, <span class="arg">y1</span>,...,<span class=
"arg">xN</span>, <span class="arg">yN</span>) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -1982,7 +1981,8 @@ <h3 id="polyline">polyline</h3>
<p><span class="arg">draw</span>.polyline(<span class=
"arg">x1</span>, <span class="arg">y1</span>,...,<span class=
- "arg">xN</span>, <span class="arg">yN</span>) -&gt; draw</p>
+ "arg">xN</span>, <span class="arg">yN</span>) -&gt;
+ <em>self</em></p>
</div>
<div class="desc">
@@ -2014,7 +2014,7 @@ <h3 id="polyline">polyline</h3>
<div class="sig">
<h3 id="pop">pop</h3>
- <p><span class="arg">draw</span>.pop -&gt; <em>draw</em></p>
+ <p><span class="arg">draw</span>.pop -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2033,7 +2033,7 @@ <h3 id="pop">pop</h3>
<div class="sig">
<h3 id="push">push</h3>
- <p><span class="arg">draw</span>.push -&gt; <em>draw</em></p>
+ <p><span class="arg">draw</span>.push -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2061,7 +2061,8 @@ <h3 id="rectangle">rectangle</h3>
<p><span class="arg">draw</span>.rectangle(<span class=
"arg">x1</span>, <span class="arg">y1</span>, <span class=
- "arg">x2</span>, <span class="arg">y2</span>) -&gt; draw</p>
+ "arg">x2</span>, <span class="arg">y2</span>) -&gt;
+ <em>self</em></p>
</div>
<div class="desc">
@@ -2097,7 +2098,7 @@ <h3 id="rectangle">rectangle</h3>
<h3 id="rotate">rotate</h3>
<p><span class="arg">draw</span>.rotate(<span class=
- "arg">degrees</span>) -&gt; <em>draw</em></p>
+ "arg">degrees</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2133,7 +2134,7 @@ <h3 id="roundrectangle">roundrectangle</h3>
"arg">x1</span>, <span class="arg">y1</span>, <span class=
"arg">x2</span>, <span class="arg">y2</span>, <span class=
"arg">cw</span>, <span class="arg">ch</span>) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -2175,7 +2176,7 @@ <h3 id="scale">scale</h3>
<p><span class="arg">draw</span>.scale(<span class=
"arg">sx</span>, <span class="arg">sy</span>) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -2203,7 +2204,7 @@ <h3 id="scale">scale</h3>
<h3 id="skewx">skewx</h3>
<p><span class="arg">draw</span>.skewx(<span class=
- "arg">aFloat</span>) -&gt; <em>draw</em></p>
+ "arg">float</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2235,7 +2236,7 @@ <h3 id="skewx">skewx</h3>
<h3 id="skewy">skewy</h3>
<p><span class="arg">draw</span>.skewy(<span class=
- "arg">aFloat</span>) -&gt; <em>draw</em></p>
+ "arg">float</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2267,7 +2268,7 @@ <h3 id="skewy">skewy</h3>
<h3 id="stroke">stroke</h3>
<p><span class="arg">draw</span>.stroke(<span class=
- "arg">aString</span>) -&gt; <em>draw</em></p>
+ "arg">string</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2293,7 +2294,7 @@ <h3 id="stroke_antialias">stroke_antialias</h3>
<p><span class=
"arg">draw</span>.stroke_antialias(<code>true</code> or
- <code>false</code>) -&gt; <em>draw</em></p>
+ <code>false</code>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2308,7 +2309,7 @@ <h3 id="stroke_dasharray">stroke_dasharray</h3>
<p><span class="arg">draw</span>.stroke_dasharray(<span class=
"arg">x1</span>,...,<span class="arg">xn</span>) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -2350,7 +2351,7 @@ <h3 id="stroke_dasharray">stroke_dasharray</h3>
<h3 id="stroke_dashoffset">stroke_dashoffset</h3>
<p><span class="arg">draw</span>.stroke_dashoffset(<span class=
- "arg">anInteger</span>) -&gt; <em>draw</em></p>
+ "arg">integer</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2375,7 +2376,7 @@ <h3 id="stroke_dashoffset">stroke_dashoffset</h3>
<h3 id="stroke_linecap">stroke_linecap</h3>
<p><span class="arg">draw</span>.stroke_linecap(<span class=
- "arg">aString</span>) -&gt; <em>draw</em></p>
+ "arg">string</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2408,7 +2409,7 @@ <h3 id="stroke_linecap">stroke_linecap</h3>
<h3 id="stroke_linejoin">stroke_linejoin</h3>
<p><span class="arg">draw</span>.stroke_linejoin(<span class=
- "arg">aString</span>) -&gt; <em>draw</em></p>
+ "arg">string</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2444,7 +2445,7 @@ <h3 id="stroke_linejoin">stroke_linejoin</h3>
<h3 id="stroke_miterlimit">stroke_miterlimit</h3>
<p><span class="arg">draw</span>.stroke_miterlimit(<span class=
- "arg">aFloat</span>) -&gt; <em>draw</em></p>
+ "arg">float</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2470,8 +2471,8 @@ <h3 id="stroke_miterlimit">stroke_miterlimit</h3>
<h3 id="stroke_opacity">stroke_opacity</h3>
<p><span class="arg">draw</span>.stroke_opacity(<span class=
- "arg">aFloat</span> or <span class="arg">aString</span>) -&gt;
- <em>draw</em></p>
+ "arg">float</span> or <span class="arg">string</span>) -&gt;
+ <em>self</em></p>
</div>
<div class="desc">
@@ -2503,7 +2504,7 @@ <h3 id="stroke_opacity">stroke_opacity</h3>
<h3 id="stroke_width">stroke_width</h3>
<p><span class="arg">draw</span>.stroke_width(<span class=
- "arg">anInteger</span>) -&gt; <em>draw</em></p>
+ "arg">integer</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2527,7 +2528,7 @@ <h3 id="text">text</h3>
<p><span class="arg">draw</span>.text(<span class=
"arg">x</span>,<span class="arg">y</span>, <span class=
- "arg">text</span>) -&gt; <em>draw</em></p>
+ "arg">text</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2599,7 +2600,7 @@ <h3 id="text">text</h3>
<h3 id="text_align">text_align</h3>
<p><span class="arg">draw</span>.text_align(<span class=
- "arg">anAlignType</span>) -&gt; <em>draw</em></p>
+ "arg">alignment</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2627,7 +2628,7 @@ <h3 id="text_align">text_align</h3>
<h3 id="text_anchor">text_anchor</h3>
<p><span class="arg">draw</span>.text_anchor(<span class=
- "arg">anAnchorType</span>) -&gt; <em>draw</em></p>
+ "arg">anchor</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2651,7 +2652,7 @@ <h3 id="text_antialias">text_antialias</h3>
<p><span class=
"arg">draw</span>.text_antialias(<code>true</code> or
- <code>false</code>) -&gt; <em>draw</em></p>
+ <code>false</code>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2684,7 +2685,7 @@ <h3 id="text_antialias">text_antialias</h3>
<h3 id="text_undercolor">text_undercolor</h3>
<p><span class="arg">draw</span>.text_undercolor(<span class=
- "arg">aString</span>) -&gt; <em>draw</em></p>
+ "arg">string</span>) -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -2703,7 +2704,8 @@ <h3 id="text_undercolor">text_undercolor</h3>
<h4>Example</h4>
- <p><a href="javascript:popup('text_undercolor.rb.html')"><img src=
+ <p><a href=
+ "javascript:popup('text_undercolor.rb.html')"><img src=
"ex/text_undercolor.gif" alt="text_undercolor example" title=
"Click to see the example script" /></a></p>
</div>
@@ -2713,7 +2715,7 @@ <h3 id="translate">translate</h3>
<p><span class="arg">draw</span>.translate(<span class=
"arg">tx</span>, <span class="arg">ty</span>) -&gt;
- <em>draw</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -2751,8 +2753,7 @@ <h2 class="methods" id="attributes">annotate attributes</h2>
<div class="sig">
<h3 id="affine_eq">affine=</h3>
- <p><span class="arg">draw.</span>.affine =
- <em>anAffineMatrix</em></p>
+ <p><span class="arg">draw</span>.affine = <em>matrix</em></p>
</div>
<div class="desc">
@@ -2769,8 +2770,7 @@ <h3 id="affine_eq">affine=</h3>
<div class="sig">
<h3 id="align_eq">align=</h3>
- <p><span class="arg">draw.</span>.align =
- <em>anAlignType</em></p>
+ <p><span class="arg">draw</span>.align = <em>alignment</em></p>
</div>
<div class="desc">
@@ -2789,7 +2789,7 @@ <h3 id="align_eq">align=</h3>
<h3 id="decorate_eq">decorate=</h3>
<p><span class="arg">draw</span>.decorate =
- <em>aDecorationType</em></p>
+ <em>decoration</em></p>
</div>
<div class="desc">
@@ -2807,7 +2807,7 @@ <h3 id="decorate_eq">decorate=</h3>
<div class="sig">
<h3 id="density_eq">density=</h3>
- <p><span class="arg">draw</span>.density = <em>aString</em></p>
+ <p><span class="arg">draw</span>.density = <em>string</em></p>
</div>
<div class="desc">
@@ -2820,8 +2820,7 @@ <h3 id="density_eq">density=</h3>
<div class="sig">
<h3 id="encoding_eq">encoding=</h3>
- <p><span class="arg">draw</span>.encoding =
- <em>aString</em></p>
+ <p><span class="arg">draw</span>.encoding = <em>string</em></p>
</div>
<div class="desc">
@@ -2839,8 +2838,8 @@ <h3 id="encoding_eq">encoding=</h3>
<div class="sig">
<h3 id="fill_eq">fill=</h3>
- <p><span class="arg">draw</span>.fill = <em>aString</em> or
- <em>aPixel</em></p>
+ <p><span class="arg">draw</span>.fill = <em>string</em> or
+ <em>pixel</em></p>
</div>
<div class="desc">
@@ -2856,7 +2855,7 @@ <h3 id="fill_eq">fill=</h3>
<h3 id="fill_pattern_eq">fill_pattern=</h3>
<p><span class="arg">draw</span>.fill_pattern =
- <em>anImage</em></p>
+ <em>image</em></p>
</div>
<div class="desc">
@@ -2877,7 +2876,7 @@ <h3 id="fill_pattern_eq">fill_pattern=</h3>
<div class="sig">
<h3 id="font_eq">font=</h3>
- <p><span class="arg">draw</span>.font = <em>aString</em></p>
+ <p><span class="arg">draw</span>.font = <em>string</em></p>
</div>
<div class="desc">
@@ -2891,7 +2890,7 @@ <h3 id="font_eq">font=</h3>
<h3 id="font_family_eq">font_family=</h3>
<p><span class="arg">draw</span>.font_family =
- <em>aString</em></p>
+ <em>string</em></p>
</div>
<div class="desc">
@@ -2905,7 +2904,7 @@ <h3 id="font_family_eq">font_family=</h3>
<h3 id="font_stretch_eq">font_stretch=</h3>
<p><span class="arg">draw</span>.font_stretch =
- <em>aStretchType</em></p>
+ <em>stretch</em></p>
</div>
<div class="desc">
@@ -2921,7 +2920,7 @@ <h3 id="font_stretch_eq">font_stretch=</h3>
<h3 id="font_style_eq">font_style=</h3>
<p><span class="arg">draw</span>.font_style =
- <em>aStyleType</em></p>
+ <em>style</em></p>
</div>
<div class="desc">
@@ -2939,7 +2938,7 @@ <h3 id="font_style_eq">font_style=</h3>
<h3 id="font_weight_eq">font_weight=</h3>
<p><span class="arg">draw</span>.font_weight =
- <em>aWeightType</em></p>
+ <em>weight</em></p>
</div>
<div class="desc">
@@ -2957,8 +2956,7 @@ <h3 id="font_weight_eq">font_weight=</h3>
<div class="sig">
<h3 id="gravity_eq">gravity=</h3>
- <p><span class="arg">draw</span>.gravity =
- <em>aGravityType</em></p>
+ <p><span class="arg">draw</span>.gravity = <em>gravity</em></p>
</div>
<div class="desc">
@@ -2977,7 +2975,7 @@ <h3 id="gravity_eq">gravity=</h3>
<h3 id="pointsize_eq">pointsize=</h3>
<p><span class="arg">draw</span>.pointsize =
- <em>anNumeric</em></p>
+ <em>integer</em></p>
</div>
<div class="desc">
@@ -2989,8 +2987,7 @@ <h3 id="pointsize_eq">pointsize=</h3>
<div class="sig">
<h3 id="rotation_eq">rotation=</h3>
- <p><span class="arg">draw</span>.rotation =
- <em>aNumeric</em></p>
+ <p><span class="arg">draw</span>.rotation = <em>number</em></p>
</div>
<div class="desc">
@@ -3006,8 +3003,8 @@ <h3 id="rotation_eq">rotation=</h3>
<div class="sig">
<h3 id="stroke_eq">stroke=</h3>
- <p><span class="arg">draw</span>.stroke = <em>aString</em> or
- <em>aPixel</em></p>
+ <p><span class="arg">draw</span>.stroke = <em>string</em> or
+ <em>pixel</em></p>
</div>
<div class="desc">
@@ -3024,7 +3021,7 @@ <h3 id="stroke_eq">stroke=</h3>
<h3 id="stroke_pattern_eq">stroke_pattern=</h3>
<p><span class="arg">draw</span>.stroke_pattern =
- <em>anImage</em></p>
+ <em>image</em></p>
</div>
<div class="desc">
@@ -3042,8 +3039,7 @@ <h3 id="stroke_pattern_eq">stroke_pattern=</h3>
<div class="sig">
<h3 id="stroke_width_eq">stroke_width=</h3>
- <p><span class="arg">draw</span>.stroke =
- <em>anInteger</em></p>
+ <p><span class="arg">draw</span>.stroke = <em>integer</em></p>
</div>
<div class="desc">
@@ -3069,7 +3065,7 @@ <h3 id="text_antialias_eq">text_antialias=</h3>
<div class="sig">
<h3 id="tile_eq">tile=</h3>
- <p><span class="arg">draw</span>.tile = <em>anImage</em></p>
+ <p><span class="arg">draw</span>.tile = <em>image</em></p>
</div>
<div class="desc">
@@ -3085,8 +3081,8 @@ <h3 id="tile_eq">tile=</h3>
<div class="sig">
<h3 id="undercolor_eq">undercolor=</h3>
- <p><span class="arg">draw</span>.undercolor = <em>aString</em>
- or <em>aPixel</em></p>
+ <p><span class="arg">draw</span>.undercolor = <em>string</em>
+ or <em>pixel</em></p>
</div>
<div class="desc">
View
155 doc/ilist.html
@@ -170,7 +170,7 @@ <h2 class="methods">attributes</h2>
<div class="sig">
<h3 id="delay_eq">delay=</h3>
- <p><span class="arg">imagelist.</span>delay=<em>n</em></p>
+ <p><span class="arg">ilist.</span>delay=<em>n</em></p>
</div>
<div class="desc">
@@ -180,7 +180,7 @@ <h3 id="delay_eq">delay=</h3>
"#ticks_per_second_eq">ticks_per_second</a> sets the length of
time between each image in an animation. The
<code>delay=</code> attribute assigns the same delay to all the
- images in the imagelist. Use <a href=
+ images in the ilist. Use <a href=
"imageattrs.html#delay">Image#delay=</a> to set different delay
values on individual images.</p>
@@ -195,7 +195,7 @@ <h3 id="delay_eq">delay=</h3>
<h4>Example</h4>
<pre>
-imagelist.delay = 20 # delay 1/5 of a second between images.
+ilist.delay = 20 # delay 1/5 of a second between images.
</pre>
<h4>See also</h4>
@@ -206,7 +206,7 @@ <h3 id="delay_eq">delay=</h3>
<div class="sig">
<h3 id="iterations_eq">iterations=</h3>
- <p><span class="arg">imagelist.</span>iterations=<em>n</em></p>
+ <p><span class="arg">ilist.</span>iterations=<em>n</em></p>
</div>
<div class="desc">
@@ -229,15 +229,15 @@ <h3 id="iterations_eq">iterations=</h3>
<h4>Example</h4>
<pre>
-imagelist.iterations = 10
+ilist.iterations = 10
</pre>
</div>
<div class="sig">
<h3 id="length">length</h3>
- <p><span class="arg">imagelist.</span>length -&gt;
- <em>anInteger</em></p>
+ <p><span class="arg">ilist.</span>length -&gt;
+ <em>integer</em></p>
</div>
<div class="desc">
@@ -255,10 +255,9 @@ <h3 id="length">length</h3>
<div class="sig">
<h3 id="scene">scene, scene=</h3>
- <p><span class="arg">imagelist</span>.scene -&gt;
- <em>anInteger</em><br />
- <span class="arg">imagelist</span>.scene =
- <em>anInteger</em></p>
+ <p><span class="arg">ilist</span>.scene -&gt;
+ <em>integer</em><br />
+ <span class="arg">ilist</span>.scene = <em>integer</em></p>
</div>
<div class="desc">
@@ -270,16 +269,16 @@ <h3 id="scene">scene, scene=</h3>
<h4>Example</h4>
<pre>
-imagelist.scene = 10
-imagelist.scene &raquo; 10
+ilist.scene = 10
+ilist.scene &raquo; 10
</pre>
</div>
<div class="sig">
<h3 id="ticks_per_second_eq">ticks_per_second=</h3>
- <p><span class="arg">imagelist</span>.ticks_per_second =
- <em>anInteger</em></p>
+ <p><span class="arg">ilist</span>.ticks_per_second =
+ <em>integer</em></p>
</div>
<div class="desc">
@@ -291,7 +290,7 @@ <h3 id="ticks_per_second_eq">ticks_per_second=</h3>
<h4>Example</h4>
<pre>
-imagelist.ticks_per_second = 1000
+ilist.ticks_per_second = 1000
</pre>
</div>
@@ -404,8 +403,8 @@ <h3 id="array_methods">Array methods</h3>
<div class="sig">
<h3 id="spaceship">&lt;=&gt;</h3>
- <p><span class="arg">imagelist</span> &lt;=&gt; <span class=
- "arg">anOtherImageList</span> -&gt; -1, 0, 1</p>
+ <p><span class="arg">ilist</span> &lt;=&gt; <span class=
+ "arg">other_imagelist</span> -&gt; -1, 0, 1</p>
</div>
<div class="desc">
@@ -442,7 +441,7 @@ <h3 id="spaceship">&lt;=&gt;</h3>
<div class="sig">
<h3 id="animate">animate</h3>
- <p><span class="arg">imagelist.</span>animate(<span class=
+ <p><span class="arg">ilist.</span>animate(<span class=
"arg">[delay]</span>) <span class="arg">[&nbsp;{ optional
arguments }&nbsp;]</span> -&gt; <em>self</em></p>
</div>
@@ -461,8 +460,8 @@ <h3 id="animate">animate</h3>
<h4>Example</h4>
<pre>
-imagelist.animate
-imagelist.animate { self.server_name = "other:0.0" }
+ilist.animate
+ilist.animate { self.server_name = "other:0.0" }
</pre>
<h4>See also</h4>
@@ -482,8 +481,8 @@ <h3 id="animate">animate</h3>
<div class="sig">
<h3 id="append">append</h3>
- <p><span class="arg">imagelist.</span>append(<code>true</code>
- or <code>false</code>) -&gt; <em>anImage</em></p>
+ <p><span class="arg">ilist.</span>append(<code>true</code> or
+ <code>false</code>) -&gt; <em>image</em></p>
</div>
<div class="desc">
@@ -515,8 +514,8 @@ <h3 id="append">append</h3>
<div class="sig">
<h3 id="average">average</h3>
- <p><span class="arg">imagelist.</span>average -&gt;
- <em>anImage</em></p>
+ <p><span class="arg">ilist.</span>average -&gt;
+ <em>image</em></p>
</div>
<div class="desc">
@@ -556,8 +555,8 @@ <h3 id="average">average</h3>
<div class="sig">
<h3 id="clone">clone</h3>
- <p><span class="arg">imagelist</span>.clone -&gt;
- <em>anImageList</em></p>
+ <p><span class="arg">ilist</span>.clone -&gt;
+ <em>other_imagelist</em></p>
</div>
<div class="desc">
@@ -578,8 +577,8 @@ <h3 id="clone">clone</h3>
<div class="sig">
<h3 id="coalesce">coalesce</h3>
- <p><span class="arg">imagelist.</span>coalesce -&gt;
- <em>anImageList</em></p>
+ <p><span class="arg">ilist.</span>coalesce -&gt;
+ <em>imagelist</em></p>
</div>
<div class="desc">
@@ -632,7 +631,7 @@ <h3 id="composite_layers">composite_layers</h3>
"arg">destination_list</span>.composite_layers(<span class=
"arg">source_list</span>, <span class=
"arg">operator</span>=<code>OverCompositeOp</code>) -&gt;
- <em>anImageList</em></p>
+ <em>imagelist</em></p>
</div>
<div class="desc">
@@ -694,8 +693,8 @@ <h3 id="composite_layers">composite_layers</h3>
<div class="sig">
<h3 id="copy">copy</h3>
- <p><span class="arg">imagelist.</span>copy -&gt;
- <em>anImageList</em></p>
+ <p><span class="arg">ilist.</span>copy -&gt;
+ <em>other_imagelist</em></p>
</div>
<div class="desc">
@@ -723,8 +722,8 @@ <h3 id="copy">copy</h3>
<div class="sig">
<h3 id="cur_image">cur_image</h3>
- <p><span class="arg">imagelist.</span>cur_image -&gt;
- <em>anImage</em></p>
+ <p><span class="arg">ilist.</span>cur_image -&gt;
+ <em>image</em></p>
</div>
<div class="desc">
@@ -749,8 +748,8 @@ <h3 id="cur_image">cur_image</h3>
<div class="sig">
<h3 id="deconstruct">deconstruct</h3>
- <p><span class="arg">imagelist.</span>deconstruct -&gt;
- <em>anImageList</em></p>
+ <p><span class="arg">ilist.</span>deconstruct -&gt;
+ <em>imagelist</em></p>
</div>
<div class="desc">
@@ -785,8 +784,8 @@ <h3 id="deconstruct">deconstruct</h3>
<div class="sig">
<h3 id="dup">dup</h3>
- <p><span class="arg">imagelist</span>.dup -&gt;
- <em>anImageList</em></p>
+ <p><span class="arg">ilist</span>.dup -&gt;
+ <em>other_imagelist</em></p>
</div>
<div class="desc">
@@ -804,7 +803,7 @@ <h3 id="dup">dup</h3>
<div class="sig">
<h3 id="display">display</h3>
- <p><span class="arg">imagelist.</span>display <span class=
+ <p><span class="arg">ilist.</span>display <span class=
"arg">[&nbsp;{ optional arguments }&nbsp;]</span> -&gt;
<em>self</em></p>
</div>
@@ -840,8 +839,8 @@ <h3 id="display">display</h3>
<div class="sig">
<h3 id="flatten_images">flatten_images</h3>
- <p><span class="arg">imagelist.</span>flatten_images -&gt;
- <em>anImage</em></p>
+ <p><span class="arg">ilist.</span>flatten_images -&gt;
+ <em>image</em></p>
</div>
<div class="desc">
@@ -881,10 +880,9 @@ <h3 id="flatten_images">flatten_images</h3>
<div class="sig">
<h3 id="from_blob">from_blob</h3>
- <p><span class=
- "arg">imagelist.</span>from_blob(blob<span class="arg">[,
- blob...]</span>) <span class="arg">[&nbsp;{ optional arguments
- }&nbsp;]</span> -&gt; <em>self</em></p>
+ <p><span class="arg">ilist.</span>from_blob(blob<span class=
+ "arg">[, blob...]</span>) <span class="arg">[&nbsp;{ optional
+ arguments }&nbsp;]</span> -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -938,7 +936,9 @@ <h3 id="from_blob">from_blob</h3>
<div class="sig">
<h3 id="fx">fx</h3>
- <p>imagelist.fx(expression [, channel...]) -&gt; anImage</p>
+ <p><span class="arg">ilist</span> .fx(<span class=
+ "arg">expression</span> [, <span class=
+ "arg">channel</span>...]) -&gt; <em>image</em></p>
</div>
<div class="desc">
@@ -1015,8 +1015,8 @@ <h3 id="fx">fx</h3>
<div class="sig">
<h3 id="inspect">inspect</h3>
- <p><span class="arg">imagelist.</span>inspect -&gt;
- <em>aString</em></p>
+ <p><span class="arg">ilist.</span>inspect -&gt;
+ <em>string</em></p>
</div>
<div class="desc">
@@ -1049,9 +1049,9 @@ <h3 id="inspect">inspect</h3>
<div class="sig">
<h3 id="map">map</h3>
- <p><span class="arg">imagelist</span>.map(<span class=
+ <p><span class="arg">ilist</span>.map(<span class=
"arg">reference</span>, <span class="arg">dither</span>) -&gt;
- <em>anImageList</em></p>
+ <em>imagelist</em></p>
</div>
<div class="desc">
@@ -1105,9 +1105,9 @@ <h3 id="map">map</h3>
<div class="sig">
<h3 id="montage">montage</h3>
- <p><span class="arg">imagelist.</span>montage <span class=
+ <p><span class="arg">ilist.</span>montage <span class=
"arg">[&nbsp;{ optional arguments }&nbsp;]</span> -&gt;
- <em>anImageList</em></p>
+ <em>imagelist</em></p>
</div>
<div class="desc">
@@ -1318,8 +1318,8 @@ <h3 id="montage">montage</h3>
<div class="sig">
<h3 id="morph">morph</h3>
- <p><span class="arg">imagelist.</span>morph(<span class=
- "arg">n</span>) -&gt; <em>anImageList</em></p>
+ <p><span class="arg">ilist.</span>morph(<span class=
+ "arg">n</span>) -&gt; <em>imagelist</em></p>
</div>
<div class="desc">
@@ -1364,8 +1364,8 @@ <h3 id="morph">morph</h3>
<div class="sig">
<h3 id="mosaic">mosaic</h3>
- <p><span class="arg">imagelist.</span>mosaic -&gt;
- <em>anImage</em></p>
+ <p><span class="arg">ilist.</span>mosaic -&gt;
+ <em>image</em></p>
</div>
<div class="desc">
@@ -1398,7 +1398,7 @@ <h3 id="mosaic">mosaic</h3>
<div class="sig">
<h3 id="new_image">new_image</h3>
- <p><span class="arg">imagelist.</span>new_image(<span class=
+ <p><span class="arg">ilist.</span>new_image(<span class=
"arg">columns</span>, <span class="arg">rows[, fill]</span>)
<span class="arg">[&nbsp;{ optional arguments }&nbsp;]</span>
-&gt; <em>self</em></p>
@@ -1434,17 +1434,16 @@ <h3 id="new_image">new_image</h3>
<p>Create a square red image.</p>
<pre>
-imagelist = Magick::ImageList.new
-imagelist.new_image(100, 100) { self.background_color = "red" }
+ilist = Magick::ImageList.new
+ilist.new_image(100, 100) { self.background_color = "red" }
</pre>
</div>
<div class="sig">
<h3 id="optimize_layers">optimize_layers</h3>
- <p><span class=
- "arg">imagelist</span>.optimize_layers(<span class=
- "arg">layer_method</span>) -&gt; <em>anImageList</em></p>
+ <p><span class="arg">ilist</span>.optimize_layers(<span class=
+ "arg">layer_method</span>) -&gt; <em>imagelist</em></p>
</div>
<div class="desc">
@@ -1648,10 +1647,10 @@ <h3 id="optimize_layers">optimize_layers</h3>
<div class="sig">
<h3 id="ping">ping</h3>
- <p><span class="arg">imagelist.</span>ping(<span class=
+ <p><span class="arg">ilist.</span>ping(<span class=
"arg">filename</span>[, <span class="arg">filename</span>...])
-&gt; <em>self</em><br />
- <span class="arg">imagelist.</span>ping(<span class=
+ <span class="arg">ilist.</span>ping(<span class=
"arg">file</span>[, <span class="arg">file</span>...]) -&gt;
<em>self</em></p>
</div>
@@ -1675,8 +1674,8 @@ <h3 id="ping">ping</h3>
<h4>Example</h4>
<pre>
-imagelist = Magick::ImageList.new
-imagelist.ping "Button_A.gif"
+ilist = Magick::ImageList.new
+ilist.ping "Button_A.gif"
puts "The image has #{i.columns} columns and #{i.rows} rows." &raquo;
The image has 127 columns and 120 rows.
</pre>
@@ -1691,11 +1690,10 @@ <h3 id="ping">ping</h3>
<div class="sig">
<h3 id="quantize">quantize</h3>
- <p><span class="arg">imagelist.</span>quantize(nc=256,
+ <p><span class="arg">ilist.</span>quantize(nc=256,
colorspace=<code>Magick::RGBColorspace</code>,
dither=<code>true</code>, tree_depth=0,
- measure_error=<code>false</code>) -&gt;
- <em>anImageList</em></p>
+ measure_error=<code>false</code>) -&gt; <em>imagelist</em></p>
</div>
<div class="desc">
@@ -1791,13 +1789,13 @@ <h3 id="quantize">quantize</h3>
<div class="sig">
<h3 id="read">read</h3>
- <p><span class="arg">imagelist.</span>read(<span class=
+ <p><span class="arg">ilist.</span>read(<span class=
"arg">filename[, filename...]</span>) <span class=
"arg">[&nbsp;{ optional arguments }&nbsp;]</span> -&gt;
<em>self</em><br />
- <span class="arg">imagelist.</span>read(<span class=
- "arg">file[, file...]</span>) <span class="arg">[&nbsp;{
- optional arguments }&nbsp;]</span> -&gt; <em>self</em></p>
+ <span class="arg">ilist.</span>read(<span class="arg">file[,
+ file...]</span>) <span class="arg">[&nbsp;{ optional arguments
+ }&nbsp;]</span> -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -1852,9 +1850,9 @@ <h3 id="read">read</h3>
<div class="sig">
<h3 id="to_blob">to_blob</h3>
- <p><span class="arg">imagelist.</span>to_blob <span class=
+ <p><span class="arg">ilist.</span>to_blob <span class=
"arg">[&nbsp;{ optional arguments }&nbsp;]</span> -&gt;
- <em>aString</em></p>
+ <em>string</em></p>
</div>
<div class="desc">
@@ -1893,8 +1891,7 @@ <h3 id="to_blob">to_blob</h3>
<div class="sig">
<h3 id="to_a">to_a</h3>
- <p><span class="arg">imagelist</span>.to_a -&gt;
- <em>anArray</em></p>
+ <p><span class="arg">ilist</span>.to_a -&gt; <em>array</em></p>
</div>
<div class="desc">
@@ -1910,10 +1907,10 @@ <h3 id="to_a">to_a</h3>
<div class="sig">
<h3 id="write">write</h3>
- <p><span class="arg">imagelist.</span>write(<span class=
+ <p><span class="arg">ilist.</span>write(<span class=
"arg">filename</span>) <span class="arg">[&nbsp;{ optional
arguments }&nbsp;]</span> -&gt; <em>self</em><br />
- <span class="arg">imagelist.</span>write(<span class=
+ <span class="arg">ilist.</span>write(<span class=
"arg">file</span>) <span class="arg">[&nbsp;{ optional
arguments }&nbsp;]</span> -&gt; <em>self</em></p>
</div>
View
407 doc/image1.html
@@ -266,7 +266,7 @@ <h3 id="capture">capture</h3>
"arg">screen=</span><code>false</code>, <span class=
"arg">borders=</span><code>false</code>) [ <span class=
"arg">{&nbsp;optional arguments&nbsp;}</span> ] -&gt;
- <em>anImage</em></p>
+ <em>image</em></p>
</div>
<div class="desc">
@@ -335,7 +335,7 @@ <h3 id="capture">capture</h3>
<h4>Example</h4>
<pre>
-img = Magick::Image.capture {
+img = Image.capture {
self.filename = "root"
}
</pre>
@@ -344,10 +344,10 @@ <h3 id="capture">capture</h3>
<div class="sig">
<h3 id="combine">combine</h3>
- <p>Image.combine(<span class="arg">red_ch</span>=nil[,
- <span class="arg">green_ch</span>=nil[, <span class=
- "arg">blue_ch</span>=nil[<span class="arg">,
- opacity_ch</span>=nil]]]) -&gt;<em>anImage</em></p>
+ <p>Image.combine(<span class="arg">red_ch</span>=nil,
+ <span class="arg">green_ch</span>=nil, <span class=
+ "arg">blue_ch</span>=nil<span class="arg">,
+ opacity_ch</span>=nil) -&gt;<em>image</em></p>
</div>
<div class="desc">
@@ -392,7 +392,7 @@ <h3 id="constitute">constitute</h3>
<p>Image.constitute(<span class="arg">width</span>,
<span class="arg">height</span>, <span class="arg">map</span>,
- <span class="arg">pixels</span>) -&gt; <em>anImage</em></p>
+ <span class="arg">pixels</span>) -&gt; <em>image</em></p>
</div>
<div class="desc">
@@ -437,7 +437,7 @@ <h3 id="constitute">constitute</h3>
<h4>Example</h4>
<pre>
-image = Magick::Image.constitute(width, height, "RGB", pixels)
+image = Image.constitute(width, height, "RGB", pixels)
</pre>
<h4>See also</h4>
@@ -455,9 +455,9 @@ <h3 id="constitute">constitute</h3>
<div class="sig">
<h3 id="from_blob">from_blob</h3>
- <p>Image.from_blob(<span class="arg">aString</span>) [
+ <p>Image.from_blob(<span class="arg">string</span>) [
<span class="arg">{ optional arguments }</span> ] -&gt;
- <em>anArray</em></p>
+ <em>array</em></p>
</div>
<div class="desc">
@@ -499,7 +499,7 @@ <h3 id="new">new</h3>
<p>Image.new(<span class="arg">columns</span>, <span class=
"arg">rows</span> [, <span class="arg">fill</span>]) [
<span class="arg">{ optional arguments }</span> ] -&gt;
- <em>anImage</em></p>
+ <em>image</em></p>
</div>
<div class="desc">
@@ -533,7 +533,7 @@ <h3 id="new">new</h3>
<h4>Example</h4>
<pre>
-img = Magick::Image.new(256, 64) {
+img = Image.new(256, 64) {
self.background_color = 'red'
}
</pre>
@@ -553,9 +553,9 @@ <h3 id="ping">ping</h3>
<p>Image.ping(<span class="arg">filename</span>) [ <span class=
"arg">{ optional arguments }</span> ] -&gt;
- <em>anArray</em><br />
+ <em>array</em><br />
Image.ping(<span class="arg">file</span>) [ <span class="arg">{
- optional arguments }</span> ] -&gt; <em>anArray</em></p>
+ optional arguments }</span> ] -&gt; <em>array</em></p>
</div>
<div class="desc">
@@ -578,7 +578,7 @@ <h3 id="ping">ping</h3>
<h4>Example</h4>
<pre>
-cheetah = Magick::Image.ping("Cheetah.jpg") &raquo;
+cheetah = Image.ping("Cheetah.jpg") &raquo;
[Cheetah.jpg JPEG 1024x768 DirectClass 8-bit 101684b]
p cheetah[0].rows &raquo; 768
p cheetah[0].columns &raquo; 1024
@@ -598,9 +598,9 @@ <h3 id="read">read</h3>
<p>Image.read(<span class="arg">filename</span>) [ <span class=
"arg">{ optional arguments }</span> ] -&gt;
- <em>anArray</em><br />
+ <em>array</em><br />
Image.read(<span class="arg">file</span>) [ <span class="arg">{
- optional arguments }</span> ] -&gt; <em>anArray</em></p>
+ optional arguments }</span> ] -&gt; <em>array</em></p>
</div>
<div class="desc">
@@ -629,7 +629,7 @@ <h3 id="read">read</h3>
<h4>Example</h4>
<pre>
-animated = Magick::Image.read("animated.gif") &raquo;
+animated = Image.read("animated.gif") &raquo;
[animated.gif GIF 127x120+0+0 PseudoClass 256c 8-bit 54395b
animated.gif[1] GIF 127x120+0+0 PseudoClass 256c 8-bit 54395b,
animated.gif[2] GIF 127x120+0+0 PseudoClass 256c 8-bit 54395b]
@@ -655,7 +655,7 @@ <h3 id="read_inline">read_inline</h3>
<p>Image.read_inline(<span class="arg">content</span>) [
<span class="arg">{ optional arguments }</span> ] -&gt;
- <em>anArray</em></p>
+ <em>array</em></p>
</div>
<div class="desc">
@@ -682,7 +682,7 @@ <h3 id="read_inline">read_inline</h3>
<h4>Example</h4>
<pre>
content = "R0lGODlhnAEuAferAAAAAAcIBggJBgw..."
-img = Magick::Image.read_inline(content)
+img = Image.read_inline(content)
</pre>
<h4>See also</h4>
@@ -695,8 +695,8 @@ <h2 class="methods">instance methods</h2>
<div class="sig">
<h3 id="aref">[&nbsp;]</h3>
- <p>image[<span class="arg">key</span>] -&gt;
- <em>aString</em></p>
+ <p><span class="arg">img</span>[<span class="arg">key</span>]
+ -&gt; <em>string</em></p>
</div>
<div class="desc">
@@ -742,8 +742,8 @@ <h3 id="aref">[&nbsp;]</h3>
<div class="sig">
<h3 id="aset">[&nbsp;]=</h3>
- <p>image[<span class="arg">key</span>] = <span class=
- "arg">aString</span> -&gt; <em>image</em></p>
+ <p><span class="arg">img</span>[<span class="arg">key</span>] =
+ <span class="arg">string</span> -&gt; <em>self</em></p>
</div>
<div class="desc">
@@ -774,19 +774,19 @@ <h3 id="aset">[&nbsp;]=</h3>
<div class="sig">
<h3 id="spaceship">&lt;=&gt;</h3>
- <p><span class="arg">image</span> &lt;=&gt; <span class=
- "arg">anOtherImage</span> -&gt; -1, 0, 1</p>
+ <p><span class="arg">img</span> &lt;=&gt; <span class=
+ "arg">other_image</span> -&gt; -1, 0, 1</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Compares two images and returns -1, 0, or 1 if <span class=
- "arg">image</span> is less than, equal to, or greater than
- <span class="arg">anOtherImage</span> as determined by
- comparing the signatures of the images. If one of the arguments
- is not an image, this method raises a TypeError exception (in
- Ruby 1.6) or returns <code>nil</code> (in Ruby 1.8)</p>
+ "arg">img</span> is less than, equal to, or greater than
+ <span class="arg">other_image</span> as determined by comparing
+ the signatures of the images. If one of the arguments is not an
+ image, this method raises a TypeError exception (in Ruby 1.6)
+ or returns <code>nil</code> (in Ruby 1.8)</p>
<p>In addition to &lt;=&gt;, <code>Image</code> mixes in the
<code>Comparable</code> module, which defines the &lt;, &lt;=,
@@ -799,8 +799,8 @@ <h3 id="spaceship">&lt;=&gt;</h3>
<h4>Returns</h4>
<p>The value of <span class=
- "arg">image</span>.<code>signature</code> &lt;=&gt;
- <span class="arg">anOtherImage</span>.<code>signature</code>.</p>
+ "arg">img</span>.<code>signature</code> &lt;=&gt; <span class=
+ "arg">other_mage</span>.<code>signature</code>.</p>
<h4>See also</h4>
@@ -816,9 +816,9 @@ <h3 id="spaceship">&lt;=&gt;</h3>
<div class="sig">
<h3 id="adaptive_blur">adaptive_blur</h3>
- <p><span class="arg">image</span>.adaptive_blur(<span class=
+ <p><span class="arg">img</span>.adaptive_blur(<span class=
"arg">radius</span>=0.0, <span class="arg">sigma</span>=1.0)
- -&gt; <em>anImage</em></p>
+ -&gt; <em>image</em></p>
</div>
<div class="desc">
@@ -870,10 +870,10 @@ <h3 id="adaptive_blur">adaptive_blur</h3>
<div class="sig">
<h3 id="adaptive_blur_channel">adaptive_blur_channel</h3>
- <p><span class="arg">image</span>.adaptive_blur(<span class=
+ <p><span class="arg">img</span>.adaptive_blur(<span class=
"arg">radius</span>=0.0, <span class="arg">sigma</span>=1.0
[,<span class="arg">channel</span>...]) -&gt;
- <em>anImage</em></p>
+ <em>image</em></p>
</div>
<div class="desc">
@@ -921,12 +921,12 @@ <h3 id="adaptive_blur_channel">adaptive_blur_channel</h3>
<div class="sig">
<h3 id="adaptive_resize">adaptive_resize</h3>
- <p><span class="arg">image</span>.adaptive_resize(<span class=
+ <p><span class="arg">img</span>.adaptive_resize(<span class=
"arg">new_width</span>, <span class="arg">new_height</span>)
- -&gt; <em>anImage</em><br />
- <span class="arg">image</span>.adaptive_resize(<span class=
+ -&gt; <em>image</em><br />
+ <span class="arg">img</span>.adaptive_resize(<span class=
"arg">scale_factor</span>) -&gt; <span class=
- "arg">anImage</span></p>
+ "arg">image</span></p>
</div>
<div class="desc">
@@ -975,9 +975,9 @@ <h3 id="adaptive_resize">adaptive_resize</h3>
<div class="sig">
<h3 id="adaptive_sharpen">adaptive_sharpen</h3>
- <p><span class="arg">image</span>.adaptive_sharpen(<span class=
+ <p><span class="arg">img</span>.adaptive_sharpen(<span class=
"arg">radius</span>=0.0, <span class="arg">sigma</span>=1.0)
- -&gt; <em>anImage</em></p>
+ -&gt; <em>image</em></p>
</div>
<div class="desc">
@@ -1029,10 +1029,10 @@ <h3 id="adaptive_sharpen">adaptive_sharpen</h3>
<div class="sig">
<h3 id="adaptive_sharpen_channel">adaptive_sharpen_channel</h3>
- <p><span class="arg">image</span>.adaptive_sharpen(<span class=
+ <p><span class="arg">img</span>.adaptive_sharpen(<span class=
"arg">radius</span>=0.0, <span class="arg">sigma</span>=1.0
[,<span class="arg">channel</span>...]) -&gt;
- <em>anImage</em></p>
+ <em>image</em></p>
</div>
<div class="desc">
@@ -1080,10 +1080,9 @@ <h3 id="adaptive_sharpen_channel">adaptive_sharpen_channel</h3>
<div class="sig">
<h3 id="adaptive_threshold">adaptive_threshold</h3>
- <p><span class=
- "arg">image</span>.adaptive_threshold(<span class=
+ <p><span class="arg">img</span>.adaptive_threshold(<span class=
"arg">width</span>=3, <span class="arg">height</span>=3,
- <span class="arg">offset</span>=0) -&gt; <em>anImage</em></p>
+ <span class="arg">offset</span>=0) -&gt; <em>image</em></p>
</div>
<div class="desc">
@@ -1138,8 +1137,8 @@ <h3 id="adaptive_threshold">adaptive_threshold</h3>
<div class="sig">
<h3 id="add_noise">add_noise</h3>
- <p><span class="arg">image</span>.add_noise(<span class=
- "arg">noise_type</span>) -&gt; <em>anImage</em></p>
+ <p><span class="arg">img</span>.add_noise(<span class=
+ "arg">noise_type</span>) -&gt; <em>image</em></p>
</div>
<div class="desc">
@@ -1209,7 +1208,7 @@ <h3 id="add_noise">add_noise</h3>
<div class="sig">
<h3 id="add_profile">add_profile</h3>
- <p><span class="arg">image</span>.add_profile(<span class=
+ <p><span class="arg">img</span>.add_profile(<span class=
"arg">filename</span>) -&gt; <span class="arg">self</span></p>
</div>
@@ -1253,10 +1252,9 @@ <h3 id="add_profile">add_profile</h3>
<div class="sig">
<h3 id="add_noise_channel">add_noise_channel</h3>
- <p><span class=
- "arg">image</span>.add_noise_channel(<span class="arg">noise_type</span>
- [,<span class="arg">channel</span>...]) -&gt;
- <em>anImage</em></p>
+ <p><span class="arg">img</span>.add_noise_channel(<span class=
+ "arg">noise_type</span> [,<span class="arg">channel</span>...])
+ -&gt; <em>image</em></p>
</div>
<div class="desc">
@@ -1298,8 +1296,8 @@ <h3 id="add_noise_channel">add_noise_channel</h3>
<div class="sig">
<h3 id="affine_transform">affine_transform</h3>
- <p><span class="arg">image</span>.affine_transform(<span class=
- "arg">anAffineMatrix</span>) -&gt; <em>anImage</em></p>
+ <p><span class="arg">img</span>.affine_transform(<span class=
+ "arg">matrix</span>) -&gt; <em>image</em></p>
</div>
<div class="desc">
@@ -1349,10 +1347,10 @@ <h3 id="affine_transform">affine_transform</h3>
<div class="sig">
<h3 id="annotate">annotate</h3>
- <p><span class="arg">image.</span>annotate(<span class=
+ <p><span class="arg">img.</span>annotate(<span class=
"arg">draw, width, height, x, y, text</span>) <span class=
"arg">[&nbsp;{ additional parameters }&nbsp;]</span> -&gt;
- <em>image</em></p>
+ <em>self</em></p>
</div>
<div class="desc">
@@ -1373,8 +1371,8 @@ <h3 id="annotate">annotate</h3>
<div class="sig">
<h3 id="auto_orient">auto_orient</h3>
- <p><span class="arg">image</span>.auto_orient -&gt;
- <em>anImage</em></p>
+ <p><span class="arg">img</span>.auto_orient -&gt;
+ <em>image</em></p>
</div>
<div class="desc">
@@ -1404,7 +1402,7 @@ <h3 id="auto_orient">auto_orient</h3>
<div class="sig">
<h3 id="auto_orient_bang">auto_orient!</h3>
- <p><span class="arg">image</span>.auto_orient! -&gt;
+ <p><span class="arg">