phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[plsql] Javadoc doclint fixes

Browse Source 
References #1516 [build] doclint error during build
This commit is contained in:
Andreas Dangel
2017-01-05 22:37:18 +01:00
parent 2dfd580e93
commit 7dd7dd3512
11 changed files with 45 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
pmd-plsql/etc/grammar/PldocAST.jjt
View File

@ -1096,13 +1096,15 @@ ASTSqlStatement SqlStatement(String initiator, String terminator) :
/**
* 2011-05-15 - SRT - Added to cope with wrapped objects
A wrapped function looks like this (always terminated by one or more equals signs "="):-
<pre>
" CREATE OR REPLACE FUNCTION "TESTUSER"."GET_DATE_STRING"
/ ** Return SYSDATE formatted using the provided template.
*
*
* @param p_date_format normal TO_CHARE/TO_DATE date template
* @return formatted datestring
* @see http://www.oracle-base.com/articles/10g/WrapAndDBMS_DDL_10gR2.php#dbms_ddl
* &#64;param p_date_format normal TO_CHARE/TO_DATE date template
* &#64;return formatted datestring
* &#64;see http://www.oracle-base.com/articles/10g/WrapAndDBMS_DDL_10gR2.php#dbms_ddl
* /
wrapped
a000000
@ -1128,6 +1130,7 @@ abcd
v04omzJ0zOfHdMAzuHQlw+fAsr2ym9YI8I521pRTbnFVAHOOUw4JqPkIyj7wj4VwyL17nhYb
3qPVuL6SvhZTmEBnRtaErHpzaDuIpqZ0G4s=
"
</pre>
*/
@ -1159,7 +1162,7 @@ void WrappedObject() :
// ============================================================================
/**
* 2006-05-24 - Matthias Hendler - added MERGE, EXECUTE choice and LOOKAHEAD at <LOOP>
* 2006-05-24 - Matthias Hendler - added MERGE, EXECUTE choice and LOOKAHEAD at &lt;LOOP&gt;
*/
ASTUnlabelledStatement UnlabelledStatement() :
{}
@ -2263,7 +2266,7 @@ ASTNumericLiteral NumericLiteral() :
}
}
/** This cannot be a token because these are valid labels '<< next_msg >>", '<<"OUTER LOOP">>'
/** This cannot be a token because these are valid labels '&lt;&lt; next_msg &gt;&gt;", '&lt;&lt;"OUTER LOOP"&gt;&gt;'
*/
ASTLabel Label() :
{
@ -4951,7 +4954,7 @@ ASTKEYWORD_UNRESERVED KEYWORD_UNRESERVED (): {}
//SRT 2011-04-17 - END */
/**
* 2006-05-20 - Matthias Hendler - added <OLD> and <PARENT>
* 2006-05-20 - Matthias Hendler - added &lt;OLD&gt; and &lt;PARENT&gt;
*/
ASTID ID(): {}
{
@ -5152,7 +5155,7 @@ ASTID ID(): {}
}
/**
* 2006-05-20 - Matthias Hendler - added <OLD>, <NEW>, <LOOP>, <INT>
* 2006-05-20 - Matthias Hendler - added &lt;OLD&gt;, &lt;NEW&gt;, &lt;LOOP&gt;, &lt;INT&gt;
*/
ASTUnqualifiedID UnqualifiedID(): {}
{
@ -5185,7 +5188,7 @@ ASTUnqualifiedID UnqualifiedID(): {}
}
/**
* 2006-05-20 - Matthias Hendler - added <LIMIT>
* 2006-05-20 - Matthias Hendler - added &lt;LIMIT&gt;
*/
ASTQualifiedID QualifiedID(): {}
{

2
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/ast/ExecutableCode.java
View File

@ -13,7 +13,7 @@ public interface ExecutableCode extends Node {
/**
* Gets the name of the executable: named thus to match
* {@link net.sourceforge.pmd.lang.java.ast.ASTMethodDeclaration}.
* {@link ASTMethodDeclaration}.
*
* @return a String representing the name of the method
*/

6
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/dfa/DataFlowFacade.java
View File

@ -18,10 +18,10 @@ import net.sourceforge.pmd.lang.plsql.ast.ASTTypeMethod;
import net.sourceforge.pmd.lang.plsql.ast.PLSQLParserVisitorAdapter;
/**
* TODO What about initializers? This only processes methods and
* constructors.
*
* @author raik
* <p/>
* TODO What about initializers? This only processes methods and
* constructors
*/
public class DataFlowFacade extends PLSQLParserVisitorAdapter {
private static final String CLASS_PATH = DataFlowFacade.class.getCanonicalName();

8
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/dfa/StatementAndBraceFinder.java
View File

@ -48,11 +48,11 @@ import net.sourceforge.pmd.lang.plsql.ast.PLSQLNode;
import net.sourceforge.pmd.lang.plsql.ast.PLSQLParserVisitorAdapter;
/**
* Sublayer of DataFlowFacade. Finds all data flow nodes and stores the
* type information (@see StackObject). At last it uses this information
* to link the nodes.
*
* @author raik
* <p/>
* Sublayer of DataFlowFacade. Finds all data flow nodes and stores the
* type information (@see StackObject). At last it uses this information
* to link the nodes.
*/
public class StatementAndBraceFinder extends PLSQLParserVisitorAdapter {
private static final Logger LOGGER = Logger.getLogger(StatementAndBraceFinder.class.getName());

6
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/dfa/VariableAccessVisitor.java
View File

@ -30,10 +30,10 @@ import net.sourceforge.pmd.lang.symboltable.NameDeclaration;
import net.sourceforge.pmd.lang.symboltable.NameOccurrence;
/**
* Searches for special nodes and computes based on the sequence, the
* type of access of a variable.
*
* @author raik, Sven Jacob
* <p/>
* Searches for special nodes and computes based on the sequence, the
* type of access of a variable.
*/
public class VariableAccessVisitor extends PLSQLParserVisitorAdapter {

2
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/AbstractNcssCountRule.java
View File

@ -32,7 +32,7 @@ import net.sourceforge.pmd.util.NumericConstants;
/**
* Abstract superclass for NCSS counting methods. Analogous to and cribbed from
* {@link net.sourceforge.pmd.lang.java.rule.codesize.AbstractNcssCountRule}.
* the Java version of the rule.
*/
public abstract class AbstractNcssCountRule extends AbstractStatisticalPLSQLRule {
private static final Logger LOGGER = Logger.getLogger(AbstractNcssCountRule.class.getName());

8
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/NPathComplexityRule.java
View File

@ -397,11 +397,11 @@ public class NPathComplexityRule extends AbstractStatisticalPLSQLRule {
/**
* Calculate the boolean complexity of the given expression. NPath boolean
* complexity is the sum of && and || tokens. This is calculated by summing
* the number of children of the &&'s (minus one) and the children of the
* complexity is the sum of &amp;&amp; and || tokens. This is calculated by summing
* the number of children of the &amp;&amp;'s (minus one) and the children of the
* ||'s (minus one).
* <p>
* Note that this calculation applies to Cyclomatic Complexity as well.
*
* <p>Note that this calculation applies to Cyclomatic Complexity as well.</p>
*
* @param expr
* control structure expression

3
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/NcssMethodCountRule.java
View File

@ -10,8 +10,7 @@ import net.sourceforge.pmd.stat.DataPoint;
/**
* Non-commented source statement counter for methods.
*
* Analogous to and cribbed from
* {@link net.sourceforge.pmd.lang.java.rule.codesize.NcssMethodCountRule}.
* <p>Analogous to and cribbed from Java version of the rule.</p>
*/
public class NcssMethodCountRule extends AbstractNcssCountRule {

10
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/ExcessiveLengthRule.java
View File

@ -13,11 +13,11 @@ import net.sourceforge.pmd.stat.DataPoint;
/**
* This is a common super class for things which have excessive length.
* <p/>
* i.e. LongMethod and LongClass rules.
* <p/>
* To implement an ExcessiveLength rule, you pass in the Class of node you want
* to check, and this does the rest for you.
*
* <p>i.e. LongMethod and LongClass rules.</p>
*
* <p>To implement an ExcessiveLength rule, you pass in the Class of node you want
* to check, and this does the rest for you.</p>
*/
public class ExcessiveLengthRule extends AbstractStatisticalPLSQLRule {
private static final Logger LOGGER = Logger.getLogger(ExcessiveLengthRule.class.getName());

16
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/ExcessiveNodeCountRule.java
View File

@ -11,14 +11,14 @@ import net.sourceforge.pmd.stat.DataPoint;
/**
* This is a common super class for things which shouldn't have excessive nodes
* underneath.
* <p/>
* It expects all "visit" calls to return an Integer. It will sum all the values
* it gets, and use that as its score.
* <p/>
* To use it, override the "visit" for the nodes that need to be counted. On
* those return "new Integer(1)"
* <p/>
* All others will return 0 (or the sum of counted nodes underneath.)
*
* <p>It expects all "visit" calls to return an Integer. It will sum all the values
* it gets, and use that as its score.</p>
*
* <p>To use it, override the "visit" for the nodes that need to be counted. On
* those return "new Integer(1)"</p>
*
* <p>All others will return 0 (or the sum of counted nodes underneath.)</p>
*/
public class ExcessiveNodeCountRule extends AbstractStatisticalPLSQLRule {

8
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/symboltable/ClassScope.java
View File

@ -40,11 +40,11 @@ public class ClassScope extends AbstractScope {
}
/**
* This is only for anonymous inner classes
* <p/>
* FIXME - should have name like Foo$1, not Anonymous$1 to get this working
* This is only for anonymous inner classes.
*
* <p>FIXME - should have name like Foo$1, not Anonymous$1 to get this working
* right, the parent scope needs to be passed in when instantiating a
* ClassScope
* ClassScope</p>
*/
public ClassScope() {
// this.className = getParent().getEnclosingClassScope().getClassName()