<html>
<head>
<style><!--
body {background-color:#ffffff;}
.file {border:1px solid #eeeeee;margin-top:1em;margin-bottom:1em;}
.pathname {font-family:monospace; float:right;}
.fileheader {margin-bottom:.5em;}
.diff {margin:0;}
.tasklist {padding:4px;border:1px dashed #000000;margin-top:1em;}
.tasklist ul {margin-top:0;margin-bottom:0;}
tr.alt {background-color:#eeeeee}
#added {background-color:#ddffdd;}
#addedchars {background-color:#99ff99;font-weight:bolder;}
tr.alt #added {background-color:#ccf7cc;}
#removed {background-color:#ffdddd;}
#removedchars {background-color:#ff9999;font-weight:bolder;}
tr.alt #removed {background-color:#f7cccc;}
#copied {background-color:#ccccff;}
tr.alt #copied {background-color:#bbbbf7;}
#info {color:#888888;}
#context {background-color:#eeeeee;}
td {padding-left:.3em;padding-right:.3em;}
tr.head {border-bottom-width:1px;border-bottom-style:solid;}
tr.head td {padding:0;padding-top:.2em;}
.task {background-color:#ffff00;}
.comment {white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;white-space:pre-wrap;word-wrap:break-word;padding:4px;border:1px dashed #000000;background-color:#ffffdd}
.error {color:red;}
hr {border-width:0px;height:2px;background:black;}
--></style>
</head>
<body>
<table cellspacing="0" cellpadding="0" border="0" rules="cols">
<tr class="head"><td colspan="5">Commit in <b><tt>metaas/trunk/src</tt></b></td></tr>
<tr><td><tt>main/java/uk/co/badgersinfoil/metaas/dom/<a href="#file1">DocTag.java</a></tt> </td><td></td><td align="right" id="added">+32</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center">450 -> 451</td></tr>
<tr class="alt"><td><tt>main/java/uk/co/badgersinfoil/metaas/impl/<a href="#file2">ASTDocTag.java</a></tt> </td><td></td><td align="right" id="added">+8</td><td></td><td nowrap="nowrap" align="center">450 -> 451</td></tr>
<tr><td><tt>test/java/uk/co/badgersinfoil/metaas/<a href="#file3">DocCommentTests.java</a></tt> </td><td></td><td align="right" id="added">+9</td><td></td><td nowrap="nowrap" align="center">450 -> 451</td></tr>
<tr><td></td><td></td><td align="right" id="added">+49</td><td align="right" id="removed">-1</td><td></td></tr>
</table>
<small id="info">3 modified files</small><br />
<pre class="comment">
more documentation, and access to the name-part of a block tag
</pre>
<hr /><a name="file1" /><div class="file">
<span class="pathname">metaas/trunk/src/main/java/uk/co/badgersinfoil/metaas/dom</span><br />
<div class="fileheader"><big><b>DocTag.java</b></big> <small id="info">450 -> 451</small></div>
<pre class="diff"><small id="info">--- trunk/src/main/java/uk/co/badgersinfoil/metaas/dom/DocTag.java 2007-03-15 08:29:30 UTC (rev 450)
+++ trunk/src/main/java/uk/co/badgersinfoil/metaas/dom/DocTag.java 2007-03-16 20:57:41 UTC (rev 451)
@@ -6,9 +6,40 @@
</small></pre><pre class="diff" id="context">
package uk.co.badgersinfoil.metaas.dom;
</pre><pre class="diff" id="added">+/**
+ * A 'block' tag within a {@link DocComment}.
+ *
+ * <p>The start of a block tag is indicated within the comment by an
+ * '@'-prefixed word appearing at the start of a line (ignoring optional
+ * leading whitespace and '*' characters).</p>
+ *
+ * <p>For example the following comment includes a 'see' block tag:</p>
+ *
+ * <pre class="eg">/*
+ * * Good.
+ * * @<span/>see MyClass
+ * *<span/>/</pre>
+ *
+ * <p>If this text is not the first thing on the line, it is not interpreted
+ * as a block tag. Here, '@see' will just be interpreted as part of the
+ * description text, and metaas will not generate a DocTag for it:</p>
+ *
+ * <pre class="eg">/*
+ * * Bad. @<span/>see MyClass
+ * *<span/>/</pre>
+ *
+ * @see DocComment#addParaTag(String, String)
+ * @see DocComment#delete(DocTag)
+ * @see DocComment#findFirstTag(String)
+ * @see DocComment#findTags(String)
+ */
</pre><pre class="diff" id="context"> public interface DocTag {
</pre><pre class="diff" id="added">+ public String getName();
+
+ public void setName(String name);
+
</pre><pre class="diff" id="context"> public String getBodyString();
public void setBody(String text);
</pre><pre class="diff" id="removed">-}
</pre><pre class="diff" id="added">+}
</pre><pre class="diff"><small id="info">\ No newline at end of file
</small></pre></div>
<hr /><a name="file2" /><div class="file">
<span class="pathname">metaas/trunk/src/main/java/uk/co/badgersinfoil/metaas/impl</span><br />
<div class="fileheader"><big><b>ASTDocTag.java</b></big> <small id="info">450 -> 451</small></div>
<pre class="diff"><small id="info">--- trunk/src/main/java/uk/co/badgersinfoil/metaas/impl/ASTDocTag.java 2007-03-15 08:29:30 UTC (rev 450)
+++ trunk/src/main/java/uk/co/badgersinfoil/metaas/impl/ASTDocTag.java 2007-03-16 20:57:41 UTC (rev 451)
@@ -76,4 +76,12 @@
</small></pre><pre class="diff" id="context"> }
}
}
</pre><pre class="diff" id="added">+
+ public String getName() {
+ return ast.getStartToken().getText().substring(1);
+ }
+
+ public void setName(String name) {
+ ast.getStartToken().setText("@" + name);
+ }
</pre><pre class="diff" id="context"> }
</pre><pre class="diff"><small id="info">\ No newline at end of file
</small></pre></div>
<hr /><a name="file3" /><div class="file">
<span class="pathname">metaas/trunk/src/test/java/uk/co/badgersinfoil/metaas</span><br />
<div class="fileheader"><big><b>DocCommentTests.java</b></big> <small id="info">450 -> 451</small></div>
<pre class="diff"><small id="info">--- trunk/src/test/java/uk/co/badgersinfoil/metaas/DocCommentTests.java 2007-03-15 08:29:30 UTC (rev 450)
+++ trunk/src/test/java/uk/co/badgersinfoil/metaas/DocCommentTests.java 2007-03-16 20:57:41 UTC (rev 451)
@@ -158,6 +158,15 @@
</small></pre><pre class="diff" id="context"> assertTrue(((DocTag)i.next()).getBodyString().trim().startsWith("arg2"));
}
</pre><pre class="diff" id="added">+ public void testDocTagName() {
+ DocComment doc = clazz.getDocumentation();
+ doc.addParaTag("param", "arg0 blah");
+ DocTag tag = doc.findFirstTag("param");
+ assertEquals("param", tag.getName());
+ tag.setName("see");
+ assertEquals("see", tag.getName());
+ }
+
</pre><pre class="diff" id="context"> public void testDelete() {
DocComment doc = clazz.getDocumentation();
doc.setDescriptionString("boo\nfoo");
</pre></div>
<center><small><a href="http://www.badgers-in-foil.co.uk/projects/cvsspam/" title="commit -> email">CVSspam</a> 0.2.12</small></center>
</body></html>