Revision: 3668
Author: mikesamuel
Date: Thu Aug 27 14:23:44 2009
Log: Fix Javadoc warnings
http://codereview.appspot.com/110100
[email protected]
http://code.google.com/p/google-caja/source/detail?r=3668
Modified:
/trunk/src/com/google/caja/config/ConfigUtil.java
/trunk/src/com/google/caja/parser/MutableParseTreeNode.java
/trunk/src/com/google/caja/parser/html/AbstractElementStack.java
/trunk/src/com/google/caja/parser/html/Html5ElementStack.java
/trunk/src/com/google/caja/parser/html/XmlElementStack.java
/trunk/src/com/google/caja/render/SourceSnippetRenderer.java
/trunk/src/com/google/caja/reporting/Renderable.java
=======================================
--- /trunk/src/com/google/caja/config/ConfigUtil.java Wed Oct 29 16:10:27
2008
+++ /trunk/src/com/google/caja/config/ConfigUtil.java Thu Aug 27 14:23:44
2009
@@ -61,7 +61,7 @@
*/
public static final ImportResolver RESOURCE_RESOLVER = new
ImportResolver() {
/**
- * @inheritDoc
+ * {...@inheritdoc}
* @param uri a URI relative to base, or an absolute URI with scheme in
* {...@code ("content", "resource")}.
* @param base null or a URI with scheme in {...@code "resource"}.
=======================================
--- /trunk/src/com/google/caja/parser/MutableParseTreeNode.java Tue Dec 11
12:01:41 2007
+++ /trunk/src/com/google/caja/parser/MutableParseTreeNode.java Thu Aug 27
14:23:44 2009
@@ -22,8 +22,8 @@
public interface MutableParseTreeNode extends ParseTreeNode {
/**
- * @inheritDoc
- *
+ * {...@inheritdoc}
+ * <p>
* As per {...@link ParseTreeNode#acceptPreOrder}, but with the following
caveats
* relating to parse tree manipulation during visiting:
* <p>Will work even if visitor {...@link #replaceChild replaces} this node
or a
@@ -35,8 +35,8 @@
boolean acceptPreOrder(Visitor v, AncestorChain<?> ancestors);
/**
- * @inheritDoc
- *
+ * {...@inheritdoc}
+ * <p>
* As per {...@link ParseTreeNode#acceptPostOrder}, but with the following
* caveats relating to parse tree manipulation during visiting:
* <p>Will work even if visitor {...@link #replaceChild replaces} this node
or a
=======================================
--- /trunk/src/com/google/caja/parser/html/AbstractElementStack.java Mon
Jun 1 16:50:26 2009
+++ /trunk/src/com/google/caja/parser/html/AbstractElementStack.java Thu
Aug 27 14:23:44 2009
@@ -50,12 +50,12 @@
public final Document getDocument() { return doc; }
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public final DocumentFragment getRootElement() {
return rootElement;
}
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public void open(boolean fragment) {}
/** The current element — according to HTML5 the stack grows down.
*/
=======================================
--- /trunk/src/com/google/caja/parser/html/Html5ElementStack.java Tue May
19 14:55:02 2009
+++ /trunk/src/com/google/caja/parser/html/Html5ElementStack.java Thu Aug
27 14:23:44 2009
@@ -69,7 +69,7 @@
public final Document getDocument() { return doc; }
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public void open(boolean isFragment) {
this.isFragment = isFragment;
builder.setDoctypeExpectation(DoctypeExpectation.NO_DOCTYPE_ERRORS);
@@ -114,18 +114,18 @@
});
}
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public void finish(FilePosition endOfFile) {
builder.finish(endOfFile);
builder.closeUnclosedNodes();
}
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public Name canonicalizeElementName(String elementName) {
return Name.html(elementName);
}
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public Name canonicalizeAttributeName(String attributeName) {
return Name.html(attributeName);
}
@@ -140,7 +140,7 @@
return Strings.toLowerCase(attributeName);
}
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public DocumentFragment getRootElement() {
// libHtmlParser always produces a document with html, head, and body
tags
// which we usually don't want, so unroll it.
=======================================
--- /trunk/src/com/google/caja/parser/html/XmlElementStack.java Mon Jun 1
16:50:26 2009
+++ /trunk/src/com/google/caja/parser/html/XmlElementStack.java Thu Aug 27
14:23:44 2009
@@ -56,7 +56,7 @@
return Name.xml(attributeName);
}
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public void processTag(Token<HtmlTokenType> start, Token<HtmlTokenType>
end,
List<Attr> attrs)
throws IllegalDocumentStateException {
@@ -111,7 +111,7 @@
}
}
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public void processText(Token<HtmlTokenType> text) {
Node parent = getBottomElement();
@@ -156,7 +156,7 @@
doAppend(textNode, parent);
}
- /** @inheritDoc */
+ /** {...@inheritdoc} */
public void finish(FilePosition endOfDocument)
throws IllegalDocumentStateException {
stripIgnorableText();
=======================================
--- /trunk/src/com/google/caja/render/SourceSnippetRenderer.java Thu Aug 27
13:59:50 2009
+++ /trunk/src/com/google/caja/render/SourceSnippetRenderer.java Thu Aug 27
14:23:44 2009
@@ -57,9 +57,7 @@
if (!evidence.containsKey(renderedLine)) {
evidence.put(renderedLine, 0);
}
- evidence.put(
- renderedLine,
- evidence.get(renderedLine) + weight);
+ evidence.put(renderedLine, evidence.get(renderedLine) + weight);
}
public int computeBestRenderedLine() {
=======================================
--- /trunk/src/com/google/caja/reporting/Renderable.java Mon Mar 31
10:43:02 2008
+++ /trunk/src/com/google/caja/reporting/Renderable.java Thu Aug 27
14:23:44 2009
@@ -27,7 +27,7 @@
public interface Renderable {
/**
- * Output the textual form to
+ * Output the textual form to
* {...@link RenderContext#getOut <code>r.getOut()</code>}.
*/
void render(RenderContext r);
@@ -37,7 +37,7 @@
* @param out a channel to receive the rendered form.
* @param handler receives IOExceptions thrown by out. May be null if
out
* will not throw an IOException on append.
- * @see com.google.caja.render
+ * @see <a
href="../render/package-summary.html">com.google.caja.render</a>
*/
TokenConsumer makeRenderer(Appendable out, Callback<IOException>
handler);
}
