Skip to content

Commit e179749

Browse files
committed
More documentation fixes.
1 parent afc1830 commit e179749

3 files changed

Lines changed: 142 additions & 117 deletions

File tree

docs/magick++/CoderInfo.html

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ <h3 align="center">Magick::CoderInfo</h3>
1212
<p>The <i>CoderInfo</i> class provides the means to provide information regarding ImageMagick support for an image format (designated by a magick string). It may be used to provide support for a specific named format (provided as an argument to the constructor), or as an element of a container when format support is queried using the <a href="STL.html#coderInfoList">coderInfoList()</a> templated function.</p>
1313
<p>The following code fragment illustrates how CoderInfo may be used.</p>
1414
<pre class="code">
15-
CoderInfo info("GIF");
16-
cout &lt; info->name() &lt;&lt; ": (" &lt;&lt; info->description() &lt;&lt; ") : ";
17-
cout &lt;&lt; "Readable = ";
18-
if ( info->isReadable() )
19-
cout &lt;&lt; "true";
20-
else
21-
cout &lt;&lt; "false";
22-
cout &lt;&lt; ", ";
23-
cout &lt;&lt; "Writable = ";
24-
if ( info->isWritable() )
25-
cout &lt;&lt; "true";
26-
else
27-
cout &lt;&lt; "false";
28-
cout &lt;&lt; ", ";
29-
cout &lt;&lt; "Multiframe = ";
30-
if ( info->isMultiframe() )
31-
cout &lt;&lt; "true";
32-
else
33-
cout &lt;&lt; "false";
15+
CoderInfo info("GIF");
16+
cout &lt; info->name() &lt;&lt; ": (" &lt;&lt; info->description() &lt;&lt; ") : ";
17+
cout &lt;&lt; "Readable = ";
18+
if ( info->isReadable() )
19+
cout &lt;&lt; "true";
20+
else
21+
cout &lt;&lt; "false";
22+
cout &lt;&lt; ", ";
23+
cout &lt;&lt; "Writable = ";
24+
if ( info->isWritable() )
25+
cout &lt;&lt; "true";
26+
else
27+
cout &lt;&lt; "false";
28+
cout &lt;&lt; ", ";
29+
cout &lt;&lt; "Multiframe = ";
30+
if ( info->isMultiframe() )
31+
cout &lt;&lt; "true";
32+
else
33+
cout &lt;&lt; "false";
3434
cout &lt;&lt; endl;
3535
</pre>
3636
<p style="margin-bottom: 0cm">The methods available in the <i>CoderInfo</i> class are shown in the following table:</p>
@@ -47,12 +47,22 @@ <h3 align="center">Magick::CoderInfo</h3>
4747
<td>
4848
<p align="center"><b>Description</b></p></td></tr>
4949
<tr>
50-
<td>
50+
<td rowspan="3">
5151
<p align="center"><a name="CoderInfo"></a><font size="2">CoderInfo</font></p></td>
52-
<td bgcolor="#999999"></td>
52+
<td rowspan="3" bgcolor="#999999"></td>
5353
<td>
5454
<p><font size="2">void</font></p></td>
5555
<td>
56+
<p><font size="2">Default constructor.</font></p></td></tr>
57+
<tr>
58+
<td>
59+
<p><font size="2">const CoderInfo&amp; coder_</font></p></td>
60+
<td>
61+
<p><font size="2">Copy constructor.</font></p></td></tr>
62+
<tr>
63+
<td>
64+
<p><font size="2">const std::string&amp; name_</font></p></td>
65+
<td>
5666
<p><font size="2">Construct object corresponding to named format (e.g. "GIF"). An exception is thrown if the format is not supported.</font></p></td></tr>
5767
<tr>
5868
<td>

docs/magick++/Geometry.html

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ <h1 align="center">Magick::Geometry</h1>
1212
<p>Geometry provides a convenient means to specify a geometry
1313
argument. The object may be initialized from a C string or C++ string
1414
containing a geometry specification. It may also be initialized by
15-
more efficient parameterized constructors.
15+
more efficient parameterized constructors.
1616
</p>
1717
<h3><a name="GeometrySpecifications"></a>Geometry
1818
Specifications</h3>
1919
<p>Geometry specifications are in the form
2020
<kbd>&quot;&lt;width&gt;x&lt;height&gt;{+-}&lt;xoffset&gt;{+-}&lt;yoffset&gt;&quot;</kbd>
2121
(where <i>width</i>, <i>height</i>, <i>xoffset</i>, and <i>yoffset</i>
2222
are numbers) for specifying the size and placement location for an
23-
object.
23+
object.
2424
</p>
2525
<p style="margin-bottom: 0in">The <i>width</i> and <i>height</i>
2626
parts of the geometry specification are measured in pixels. The
@@ -29,7 +29,7 @@ <h3><a name="GeometrySpecifications"></a>Geometry
2929
the left and top and edges of the image, respectively. Both types of
3030
offsets are measured from the indicated edge of the object to the
3131
corresponding edge of the image. The X offset may be specified in the
32-
following ways:
32+
following ways:
3333
</p>
3434
<table width="90%" border="1" cellpadding="2" cellspacing="3">
3535
<col width="21*" />
@@ -53,7 +53,7 @@ <h3><a name="GeometrySpecifications"></a>Geometry
5353
</td>
5454
</tr>
5555
</table>
56-
<p style="margin-bottom: 0in">The Y offset has similar meanings:
56+
<p style="margin-bottom: 0in">The Y offset has similar meanings:
5757
</p>
5858
<table width="90%" border="1" cellpadding="2" cellspacing="3">
5959
<col width="27*" />
@@ -89,7 +89,7 @@ <h3><a name="ExtendedGeometrySpecifications"></a>ImageMagick
8989
Extended geometry strings should <em>only</em> be used <em>when resizing
9090
an image</em>. Using an extended geometry string for other
9191
applications may cause the API call to fail. The available
92-
qualifiers are shown in the following table:
92+
qualifiers are shown in the following table:
9393
</p>
9494
<p align="center" STYLE="margin-bottom: 0in"><b>ImageMagick Geometry
9595
Qualifiers</b></p>
@@ -153,10 +153,10 @@ <h3><a name="PostscriptPageSize"></a>Postscript Page Size Extension
153153
a page of that size. Since the 11x17 inch page size used in the US
154154
starts with a digit, it is not supported as a Postscript page size
155155
nickname. Instead, substitute the geometry specification &quot;<kbd>792x1224&gt;&quot;</kbd>
156-
when 11x17 output is desired.
156+
when 11x17 output is desired.
157157
</p>
158158
<p style="margin-bottom: 0in">An example of a Postscript page size
159-
specification is <kbd>&quot;letter+43+43&gt;&quot;</kbd>.
159+
specification is <kbd>&quot;letter+43+43&gt;&quot;</kbd>.
160160
</p>
161161
<p align="center" style="margin-bottom: 0in"><b>Postscript Page Size
162162
Nicknames</b></p>
@@ -472,7 +472,7 @@ <H3 align="center">Geometry Methods</H3>
472472
<p style="margin-bottom: 0in">Geometry provides methods to initialize
473473
its value from strings, from a set of parameters, or via attributes.
474474
The methods available for use in Geometry are shown in the following
475-
table:
475+
table:
476476
</p>
477477
<p align="center" style="margin-bottom: 0in"><b>Geometry Methods</b></p>
478478
<table width="100%" border="1" cellpadding="2" cellspacing="3">
@@ -495,24 +495,23 @@ <H3 align="center">Geometry Methods</H3>
495495
</td>
496496
</tr>
497497
<tr>
498-
<td rowspan="3" width="10%">
498+
<td rowspan="5" width="10%">
499499
<p>Geometry</p>
500500
</td>
501-
<td rowspan="3" width="10%" bgcolor="#666666">
501+
<td rowspan="5" width="10%" bgcolor="#666666">
502502
<p>&#160;</p>
503503
</td>
504504
<td width="44%">
505505
<p>size_t width_, size_t height_, ssize_t xOff_ =
506-
0, ssize_t yOff_ = 0, bool xNegative_ = false, bool
507-
yNegative_ = false</p>
506+
0, ssize_t yOff_ = 0</p>
508507
</td>
509508
<td width="37%">
510509
<p>Construct geometry via explicit parameters.</p>
511510
</td>
512511
</tr>
513512
<tr>
514513
<td width="44%">
515-
<p>const string geometry_</p>
514+
<p>const std::string&amp; geometry_</p>
516515
</td>
517516
<td width="37%">
518517
<p>Construct geometry from C++ string</p>
@@ -526,6 +525,22 @@ <H3 align="center">Geometry Methods</H3>
526525
<p>Construct geometry from C string</p>
527526
</td>
528527
</tr>
528+
<tr>
529+
<td width="44%">
530+
<p>const Geometry&amp; geometry_</p>
531+
</td>
532+
<td width="37%">
533+
<p>Copy constructor.</p>
534+
</td>
535+
</tr>
536+
<tr>
537+
<td width="44%">
538+
<p>const MagickCore::RectangleInfo&amp; rectangle_</p>
539+
</td>
540+
<td width="37%">
541+
<p>Construct from RectangleInfo.</p>
542+
</td>
543+
</tr>
529544
<tr>
530545
<td rowspan="2" width="10%">
531546
<p>width</p>

0 commit comments

Comments
 (0)