doc/info.html in rmagick-2.7.0 vs doc/info.html in rmagick-2.7.1
- old
+ new
@@ -2,24 +2,24 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
- "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
+ "HTML Tidy for Linux/x86 (vers 6 November 2007), see www.w3.org" />
- <title>RMagick 2.7.0: class Image::Info - Optional method
+ <title>RMagick 2.7.1: class Image::Info - Optional method
arguments</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
<meta name="Copyright" content=
"Copyright (C) 2006 by Timothy P. Hunter" />
<link rel="stylesheet" type="text/css" href="css/doc.css" />
-<script type="text/javascript" src="scripts/doc.js">
+ <script type="text/javascript" src="scripts/doc.js">
</script>
-<style type="text/css">
- /*<![CDATA[*/
+ <style type="text/css">
+/*<![CDATA[*/
/* Styles local to this page. */
h2 {
margin-top: 1em;
@@ -38,15 +38,15 @@
#compression_notes li {
font-style: italic;
}
/*]]>*/
-</style>
+ </style>
</head>
<body>
- <h6 id="header">RMagick 2.7.0 User's Guide and Reference</h6>
+ <h6 id="header">RMagick 2.7.1 User's Guide and Reference</h6>
<div class="nav">
« <a href="struct.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"constants.html">Next</a> »
@@ -245,10 +245,34 @@
<dd>The value of the option. <span class="arg">Value</span>
can be any object that responds to <code>to_s</code>. Use
<code>nil</code> to set the key to a null value.</dd>
</dl>
+ <h4 id="user_option">The "user" option</h4>
+
+ <p>The "user" option is unique to RMagick. It may be set to any
+ string. If this option is used when creating an image via one
+ of the methods listed below then the new image gets the value
+ assigned as a property as if <code>img["user"]</code> had been
+ used. In addition, the value is displayed in the string
+ returned by <code>Image#inspect</code>. The "user" property can
+ be used to help distinguish otherwise similar images when
+ debugging.</p>
+
+ <p>For example,</p>
+ <pre>
+img = Magick::Image.new(10,10) do
+ self['user'] = __FILE__ + ':' + __LINE__.to_s
+end » 10x10 DirectClass 16-bit user:test.rb:3
+</pre>
+
+ <p>These methods propogate the value of the "user" option to
+ new image(s): <code>Image.new, ImageList.new,
+ ImageList.new_image, Image.capture, Image.from_blob,
+ ImageList.from_blob, Image.read, ImageList.read,
+ Image.read_inline, and Image.ping</code>.</p>
+
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
@@ -1081,11 +1105,11 @@
<p>Set a <code>Proc</code> object as a progress monitor. This
proc can be used to monitor the progress of methods that accept
optional arguments such as <code>read</code> and
<code>write</code>. To stop monitoring, set the monitor to
<code>nil</code>. See <a href=
- "imageattrs.html#monitor">Image#monitor</a> for more information
- about the proc. This attribute is set-only.</p>
+ "imageattrs.html#monitor">Image#monitor</a> for more
+ information about the proc. This attribute is set-only.</p>
<p>If you assign a monitor to an image with
<code>self.monitor=</code> when the image is created, the image
object inherits the monitor. Any methods applied to the new
image will be monitored as well.</p>