hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

[vm] Javadoc doclint fixes

Browse Source 
References #1516 [build] doclint error during build
This commit is contained in:
Andreas Dangel
2017-01-05 22:55:00 +01:00
parent 7dd7dd3512
commit a041ea3eba
10 changed files with 23 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pmd-vm/etc/grammar/VmParser.jjt
View File

@ -309,7 +309,7 @@ TOKEN_MGR_DECLS:
/**
* pushes the current state onto the 'state stack',
* and maintains the parens counts
* public because we need it in PD & VM handling
* public because we need it in PD & VM handling
*
* @return boolean : success. It can fail if the state machine
* gets messed up (do don't mess it up :)
@ -1205,7 +1205,7 @@ void EscapedDirective() : {}
* Used to catch and process escape sequences in grammatical constructs
* as escapes outside of VTL are just characters. Right now we have both
* this and the EscapeDirective() construction because in the EscapeDirective()
* case, we want to suck in the #<directive> and here we don't. We just want
* case, we want to suck in the #&lt;directive&gt; and here we don't. We just want
* the escapes to render correctly
*/
void Escape() : {}

4
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/ASTDirective.java
View File

@ -53,10 +53,6 @@ public class ASTDirective extends AbstractVmNode {
super(p, id);
}
/**
* @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.node.VmParserVisitor,
* java.lang.Object)
*/
@Override
public Object jjtAccept(final VmParserVisitor visitor, final Object data) {
return visitor.visit(this, data);

4
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/ASTEscape.java
View File

@ -48,10 +48,6 @@ public class ASTEscape extends AbstractVmNode {
super(p, id);
}
/**
* @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.node.VmParserVisitor,
* java.lang.Object)
*/
@Override
public Object jjtAccept(final VmParserVisitor visitor, final Object data) {
return visitor.visit(this, data);

4
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/ASTMethod.java
View File

@ -55,10 +55,6 @@ public class ASTMethod extends AbstractVmNode {
super(p, id);
}
/**
* @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.node.VmParserVisitor,
* java.lang.Object)
*/
@Override
public Object jjtAccept(final VmParserVisitor visitor, final Object data) {
return visitor.visit(this, data);

8
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/ASTReference.java
View File

@ -29,7 +29,7 @@ package net.sourceforge.pmd.lang.vm.ast;
* @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
* @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
* @author <a href="mailto:Christoph.Reck@dlr.de">Christoph Reck</a>
* @author <a href="mailto:kjohnson@transparent.com>Kent Johnson</a>
* @author <a href="mailto:kjohnson@transparent.com">Kent Johnson</a>
* @version $Id: ASTReference.java 806597 2009-08-21 15:21:44Z nbubna $
*/
public class ASTReference extends AbstractVmNode {
@ -66,10 +66,6 @@ public class ASTReference extends AbstractVmNode {
super(p, id);
}
/**
* @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.node.VmParserVisitor,
* java.lang.Object)
*/
@Override
public Object jjtAccept(final VmParserVisitor visitor, final Object data) {
return visitor.visit(this, data);
@ -107,7 +103,7 @@ public class ASTReference extends AbstractVmNode {
/**
* Override of the SimpleNode method literal() Returns the literal
* representation of the node. Should be something like $<token>.
* representation of the node. Should be something like $&lt;token&gt;.
*
* @return A literal string.
*/

4
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/ASTStringLiteral.java
View File

@ -105,10 +105,6 @@ public class ASTStringLiteral extends AbstractVmNode {
}
}
/**
* @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.node.VmParserVisitor,
* java.lang.Object)
*/
@Override
public Object jjtAccept(final VmParserVisitor visitor, final Object data) {
return visitor.visit(this, data);

52
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/AbstractVmNode.java
View File

@ -71,9 +71,6 @@ public class AbstractVmNode extends AbstractNode implements VmNode {
templateName = parser.currentTemplateName;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#jjtOpen()
*/
@Override
public void jjtOpen() {
first = parser.getToken(1); // added
@ -83,9 +80,6 @@ public class AbstractVmNode extends AbstractNode implements VmNode {
}
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#jjtClose()
*/
@Override
public void jjtClose() {
last = parser.getToken(0); // added
@ -106,32 +100,18 @@ public class AbstractVmNode extends AbstractNode implements VmNode {
this.first = t;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#getFirstToken()
*/
public Token getFirstToken() {
return first;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#getLastToken()
*/
public Token getLastToken() {
return last;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#jjtAccept(org.apache.velocity.runtime.parser.node.VmParserVisitor,
* java.lang.Object)
*/
public Object jjtAccept(final VmParserVisitor visitor, final Object data) {
return visitor.visit(this, data);
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#childrenAccept(org.apache.velocity.runtime.parser.node.VmParserVisitor,
* java.lang.Object)
*/
public Object childrenAccept(final VmParserVisitor visitor, final Object data) {
if (children != null) {
for (int i = 0; i < children.length; ++i) {
@ -181,8 +161,8 @@ public class AbstractVmNode extends AbstractNode implements VmNode {
// All additional methods
/**
* @see org.apache.velocity.runtime.parser.node.Node#literal()
/*
* see org.apache.velocity.runtime.parser.node.Node#literal()
*/
public String literal() {
// if we have only one string, just return it and avoid
@ -200,50 +180,50 @@ public class AbstractVmNode extends AbstractNode implements VmNode {
return sb.toString();
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#getType()
/*
* see org.apache.velocity.runtime.parser.node.Node#getType()
*/
public int getType() {
return id;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#setInfo(int)
/*
* see org.apache.velocity.runtime.parser.node.Node#setInfo(int)
*/
public void setInfo(final int info) {
this.info = info;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#getInfo()
/*
* see org.apache.velocity.runtime.parser.node.Node#getInfo()
*/
public int getInfo() {
return info;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#setInvalid()
/*
* see org.apache.velocity.runtime.parser.node.Node#setInvalid()
*/
public void setInvalid() {
invalid = true;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#isInvalid()
/*
* see org.apache.velocity.runtime.parser.node.Node#isInvalid()
*/
public boolean isInvalid() {
return invalid;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#getLine()
/*
* see org.apache.velocity.runtime.parser.node.Node#getLine()
*/
public int getLine() {
return first.beginLine;
}
/**
* @see org.apache.velocity.runtime.parser.node.Node#getColumn()
/*
* see org.apache.velocity.runtime.parser.node.Node#getColumn()
*/
public int getColumn() {
return first.beginColumn;

4
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/TemplateParseException.java
View File

@ -25,7 +25,7 @@ import net.sourceforge.pmd.lang.vm.util.LogUtil;
/**
* This is an extension of the ParseException, which also takes a template name.
*
* @see org.apache.velocity.runtime.parser.ParseException
* <p>see also the original <code>org.apache.velocity.runtime.parser.ParseException</code></p>
*
* @author <a href="hps@intermeta.de">Henning P. Schmiedehausen</a>
* @version $Id: TemplateParseException.java 703544 2008-10-10 18:15:53Z nbubna
@ -67,7 +67,7 @@ public class TemplateParseException extends ParseException {
* true to indicate that this constructor was used to create this object.
* This constructor calls its super class with the empty string to force the
* "toString" method of parent class "Throwable" to print the error message
* in the form: ParseException: <result of getMessage>
* in the form: ParseException: &lt;result of getMessage&gt;
*
* @param currentTokenVal
* @param expectedTokenSequencesVal

2
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/directive/Directive.java
View File

@ -102,7 +102,7 @@ public abstract class Directive implements Cloneable {
}
/**
* @returns the name to be used when a scope control is provided for this
* @return the name to be used when a scope control is provided for this
* directive.
*/
public String getScopeName() {

32
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/util/VelocityCharStream.java
View File

@ -194,9 +194,6 @@ public final class VelocityCharStream implements CharStream {
}
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#BeginToken()
*/
@Override
public char BeginToken() throws java.io.IOException {
tokenBegin = -1;
@ -242,9 +239,6 @@ public final class VelocityCharStream implements CharStream {
bufcolumn[bufpos] = column;
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#readChar()
*/
@Override
public char readChar() throws java.io.IOException {
if (inBuf > 0) {
@ -277,7 +271,6 @@ public final class VelocityCharStream implements CharStream {
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#getColumn()
* @deprecated
*/
@Deprecated
@ -287,7 +280,6 @@ public final class VelocityCharStream implements CharStream {
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#getLine()
* @deprecated
*/
@Deprecated
@ -296,41 +288,26 @@ public final class VelocityCharStream implements CharStream {
return bufline[bufpos];
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#getEndColumn()
*/
@Override
public int getEndColumn() {
return bufcolumn[bufpos];
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#getEndLine()
*/
@Override
public int getEndLine() {
return bufline[bufpos];
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#getBeginColumn()
*/
@Override
public int getBeginColumn() {
return bufcolumn[tokenBegin];
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#getBeginLine()
*/
@Override
public int getBeginLine() {
return bufline[tokenBegin];
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#backup(int)
*/
@Override
public void backup(int amount) {
@ -396,9 +373,6 @@ public final class VelocityCharStream implements CharStream {
reInit(dstream, startline, startcolumn, 4096);
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#GetImage()
*/
@Override
public String GetImage() {
if (bufpos >= tokenBegin) {
@ -408,9 +382,6 @@ public final class VelocityCharStream implements CharStream {
}
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#GetSuffix(int)
*/
@Override
public char[] GetSuffix(int len) {
char[] ret = new char[len];
@ -425,9 +396,6 @@ public final class VelocityCharStream implements CharStream {
return ret;
}
/**
* @see org.apache.velocity.runtime.parser.CharStream#Done()
*/
@Override
public void Done() {
buffer = null;