<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre, #msg p { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[15] trunk/src: Added documentation tags.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd>15</dd>
<dt>Author</dt> <dd>dpruessner</dd>
<dt>Date</dt> <dd>2007-10-28 13:50:03 -0400 (Sun, 28 Oct 2007)</dd>
</dl>
<h3>Log Message</h3>
<pre>Added documentation tags. Incomplete. Need
to finish documentation</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrccolorcc">trunk/src/color.cc</a></li>
<li><a href="#trunksrcrendererbasecc">trunk/src/rendererbase.cc</a></li>
<li><a href="#trunksrcstrokecc">trunk/src/stroke.cc</a></li>
<li><a href="#trunksrctextcc">trunk/src/text.cc</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrccolorcc"></a>
<div class="modfile"><h4>Modified: trunk/src/color.cc (14 => 15)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/color.cc 2007-10-28 17:49:42 UTC (rev 14)
+++ trunk/src/color.cc 2007-10-28 17:50:03 UTC (rev 15)
</span><span class="lines">@@ -1,5 +1,15 @@
</span><span class="cx"> #include "agg4r.h"
</span><span class="cx">
</span><ins>+/* Document-class: Agg4r::Color
+ *
+ * Defines the AGG color object. This is a very basic object
+ * that holds RGBA values. These are used for fill colors.
+ *
+ * = Usage
+ * color = Agg4a::Color.new(r, g, b, a)
+ * Creates an immutable Color object.
+*/
+
</ins><span class="cx"> extern VALUE rb_mAgg4r;
</span><span class="cx"> extern VALUE rb_cAgg4r_RendererBase;
</span><span class="cx"> extern VALUE rb_cAgg4r_Color;
</span><span class="lines">@@ -33,8 +43,9 @@
</span><span class="cx"> return rvalue;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/* Initialize the structure */
</ins><span class="cx"> EXTERNAL VALUE
</span><del>-Color_initialize(VALUE vSelf, VALUE r, VALUE g, VALUE b, VALUE a)
</del><ins>+Color_initialize(VALUE vSelf, VALUE r, VALUE g, VALUE b, VALUE a)
</ins><span class="cx"> {
</span><span class="cx"> sColor* color;
</span><span class="cx"> Data_Get_Struct(vSelf, sColor, color);
</span><span class="lines">@@ -48,20 +59,29 @@
</span><span class="cx"> return vSelf;
</span><span class="cx"> }
</span><span class="cx">
</span><del>-EXTERNAL VALUE
-Color_r(VALUE vSelf)
</del><ins>+/* r reader
+ * Read the red value
+*/
+EXTERNAL VALUE Color_r(VALUE vSelf)
</ins><span class="cx"> {
</span><span class="cx"> sColor* color;
</span><span class="cx"> Data_Get_Struct(vSelf, sColor, color);
</span><span class="cx"> return rb_float_new(color->r);
</span><span class="cx"> }
</span><del>-EXTERNAL VALUE
-Color_g(VALUE vSelf)
</del><ins>+
+/* g reader
+ * Read the green value
+*/
+EXTERNAL VALUE Color_g(VALUE vSelf)
</ins><span class="cx"> {
</span><span class="cx"> sColor* color;
</span><span class="cx"> Data_Get_Struct(vSelf, sColor, color);
</span><span class="cx"> return rb_float_new(color->g);
</span><span class="cx"> }
</span><ins>+
+/* b reader
+ * Read the blue value
+*/
</ins><span class="cx"> EXTERNAL VALUE
</span><span class="cx"> Color_b(VALUE vSelf)
</span><span class="cx"> {
</span><span class="lines">@@ -69,6 +89,10 @@
</span><span class="cx"> Data_Get_Struct(vSelf, sColor, color);
</span><span class="cx"> return rb_float_new(color->b);
</span><span class="cx"> }
</span><ins>+
+/* a reader
+ * Read the alpha value
+*/
</ins><span class="cx"> EXTERNAL VALUE
</span><span class="cx"> Color_a(VALUE vSelf)
</span><span class="cx"> {
</span><span class="lines">@@ -79,6 +103,7 @@
</span><span class="cx">
</span><span class="cx"> void Init_agg4r_Color()
</span><span class="cx"> {
</span><ins>+ /* Agg4r: rb_mAgg4r */
</ins><span class="cx"> rb_cAgg4r_Color = rb_define_class_under(rb_mAgg4r,
</span><span class="cx"> "Color",
</span><span class="cx"> rb_cObject);
</span><span class="lines">@@ -92,3 +117,7 @@
</span><span class="cx"> return;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/* For the documentation engine: */
+#if false
+ rb_mAgg4r = rb_define_module("Agg4r");
+#endif
</ins></span></pre></div>
<a id="trunksrcrendererbasecc"></a>
<div class="modfile"><h4>Modified: trunk/src/rendererbase.cc (14 => 15)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/rendererbase.cc 2007-10-28 17:49:42 UTC (rev 14)
+++ trunk/src/rendererbase.cc 2007-10-28 17:50:03 UTC (rev 15)
</span><span class="lines">@@ -168,3 +168,9 @@
</span><span class="cx"> return;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+
+
+#if false
+ rb_mAgg4r = rb_define_module("Agg4r");
+#endif
+
</ins></span></pre></div>
<a id="trunksrcstrokecc"></a>
<div class="modfile"><h4>Modified: trunk/src/stroke.cc (14 => 15)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/stroke.cc 2007-10-28 17:49:42 UTC (rev 14)
+++ trunk/src/stroke.cc 2007-10-28 17:50:03 UTC (rev 15)
</span><span class="lines">@@ -110,3 +110,9 @@
</span><span class="cx"> rb_define_method(rb_cAgg4r_Stroke, "get_path", RUBY_METHOD_FUNC(Stroke_get_path), 0);
</span><span class="cx"> return;
</span><span class="cx"> }
</span><ins>+
+
+#if false
+ rb_mAgg4r = rb_define_module("Agg4r");
+#endif
+
</ins></span></pre></div>
<a id="trunksrctextcc"></a>
<div class="modfile"><h4>Modified: trunk/src/text.cc (14 => 15)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/text.cc 2007-10-28 17:49:42 UTC (rev 14)
+++ trunk/src/text.cc 2007-10-28 17:50:03 UTC (rev 15)
</span><span class="lines">@@ -133,3 +133,9 @@
</span><span class="cx"> RUBY_METHOD_FUNC(Text_get_path), 0);
</span><span class="cx"> return;
</span><span class="cx"> }
</span><ins>+
+
+#if false
+ rb_mAgg4r = rb_define_module("Agg4r");
+#endif
+
</ins></span></pre>
</div>
</div>
</body>
</html>