From 127e003ebed72a8d93b9a90564a35aa95472c49f Mon Sep 17 00:00:00 2001
From: Minh Hiep Pham <minh.pham@telecom-paristech.fr>
Date: Thu, 20 Dec 2018 12:37:08 +0100
Subject: [PATCH] Update @apram @return description warning (1er part)
---
.../compiler/tmlCPparser/ParseException.java | 5 +-
src/main/java/compiler/tmlCPparser/Token.java | 11 +--
src/main/java/compiler/tmlgrammar/Node.java | 24 +++++--
.../compiler/tmlgrammar/ParseException.java | 5 +-
.../compiler/tmlgrammar/SimpleCharStream.java | 69 +++++++++++--------
.../compiler/tmlgrammar/TMLExprParser.java | 42 ++++++-----
.../tmlgrammar/TMLExprParserTokenManager.java | 18 +++--
src/main/java/compiler/tmlgrammar/Token.java | 11 +--
.../compiler/tmlgrammar/TokenMgrError.java | 21 +++---
src/main/java/compiler/tmlparser/Node.java | 24 +++++--
.../compiler/tmlparser/ParseException.java | 5 +-
.../compiler/tmlparser/SimpleCharStream.java | 68 ++++++++++--------
.../compiler/tmlparser/TMLExprParser.java | 34 +++++----
.../tmlparser/TMLExprParserTokenManager.java | 18 +++--
src/main/java/compiler/tmlparser/Token.java | 11 +--
.../compiler/tmlparser/TokenMgrError.java | 21 +++---
src/main/java/myutil/AESEncryptor.java | 2 -
src/main/java/myutil/Conversion.java | 5 ++
.../java/myutil/externalSearch/Client.java | 7 +-
src/main/java/translator/ActivityDiagram.java | 3 +-
src/main/java/ui/AbstractCDElement.java | 11 +--
src/main/java/ui/TDiagramPanel.java | 2 +-
src/main/java/ui/TGComponent.java | 15 ++--
src/main/java/ui/ad/TADChoice.java | 11 +--
.../ui/ad/TADComponentWithSubcomponents.java | 2 +-
.../ad/TADComponentWithoutSubcomponents.java | 2 +-
src/main/java/ui/ad/TADConnector.java | 6 +-
src/main/java/ui/ad/TADForLoop.java | 2 +-
src/main/java/ui/ad/TADOneLineText.java | 2 +-
src/main/java/ui/ad/TADSequence.java | 2 +-
.../AvatarADAssociationConnector.java | 2 +-
.../java/ui/avatarad/AvatarADParallel.java | 2 +-
.../ui/procsd/JDialogAttributeProCSD.java | 2 +-
src/main/java/ui/procsd/ProCSDPort.java | 8 ++-
.../src/main/java/web/crawler/Client.java | 15 ++--
35 files changed, 293 insertions(+), 195 deletions(-)
diff --git a/src/main/java/compiler/tmlCPparser/ParseException.java b/src/main/java/compiler/tmlCPparser/ParseException.java
index bd6a13e651..614f66f6ca 100644
--- a/src/main/java/compiler/tmlCPparser/ParseException.java
+++ b/src/main/java/compiler/tmlCPparser/ParseException.java
@@ -69,6 +69,9 @@ public class ParseException extends Exception {
* in the generated parser. Calling this constructor generates
* a new object of this type with the fields "currentToken",
* "expectedTokenSequences", and "tokenImage" set.
+ * @param currentTokenVal current token
+ * @param expectedTokenSequencesVal expected token sequences
+ * @param tokenImageVal token image
*/
public ParseException(Token currentTokenVal,
int[][] expectedTokenSequencesVal,
@@ -99,7 +102,7 @@ public class ParseException extends Exception {
super();
}
- /** Constructor with message. */
+ /* Constructor with message. */
public ParseException(String message) {
super(message);
}
diff --git a/src/main/java/compiler/tmlCPparser/Token.java b/src/main/java/compiler/tmlCPparser/Token.java
index 50c0177119..eb8cd98888 100644
--- a/src/main/java/compiler/tmlCPparser/Token.java
+++ b/src/main/java/compiler/tmlCPparser/Token.java
@@ -103,6 +103,7 @@ public class Token implements java.io.Serializable {
* interpreter. This attribute value is often different from the image.
* Any subclass of Token that actually wants to return a non-null value can
* override this method as appropriate.
+ * @return : always null
*/
public Object getValue() {
return null;
@@ -113,7 +114,7 @@ public class Token implements java.io.Serializable {
*/
public Token() {}
- /**
+ /*
* Constructs a new token for the specified Image.
*/
public Token(int kind)
@@ -121,7 +122,7 @@ public class Token implements java.io.Serializable {
this(kind, null);
}
- /**
+ /*
* Constructs a new token for the specified Image and Kind.
*/
public Token(int kind, String image)
@@ -131,7 +132,7 @@ public class Token implements java.io.Serializable {
}
/**
- * Returns the image.
+ * @return : the image.
*/
public String toString()
{
@@ -139,7 +140,7 @@ public class Token implements java.io.Serializable {
}
/**
- * Returns a new Token object, by default. However, if you want, you
+ * @return : a new Token object, by default. However, if you want, you
* can create and return subclass objects based on the value of ofKind.
* Simply add the cases to the switch for all those special cases.
* For example, if you have a subclass of Token called IDToken that
@@ -149,6 +150,8 @@ public class Token implements java.io.Serializable {
*
* to the following switch statement. Then you can cast matchedToken
* variable to the appropriate type and use sit in your lexical actions.
+ * @param ofKind : integer data
+ * @param image : image
*/
public static Token newToken(int ofKind, String image)
{
diff --git a/src/main/java/compiler/tmlgrammar/Node.java b/src/main/java/compiler/tmlgrammar/Node.java
index f0c9ec780a..9b699fb470 100644
--- a/src/main/java/compiler/tmlgrammar/Node.java
+++ b/src/main/java/compiler/tmlgrammar/Node.java
@@ -59,20 +59,30 @@ interface Node {
added. */
void jjtClose();
- /** This pair of methods are used to inform the node of its
- parent. */
+ /**
+ * This pair of methods are used to inform the node of its parent
+ * @param n : node
+ */
void jjtSetParent(Node n);
Node jjtGetParent();
- /** This method tells the node to add its argument to the node's
- list of children. */
+ /**
+ * This method tells the node to add its argument to the node's list of children
+ * @param n : added node
+ * @param i : index of the added node in the node's list of children
+ */
void jjtAddChild(Node n, int i);
- /** This method returns a child node. The children are numbered
- from zero, left to right. */
+ /**
+ * This method returns a child node. The children are numbered from zero, left to right
+ * @param i : index of the child node
+ * @return : child node
+ */
Node jjtGetChild(int i);
- /** Return the number of children the node has. */
+ /**
+ * @return : the number of children the node has
+ */
int jjtGetNumChildren();
}
/* JavaCC - OriginalChecksum=4ad84079284f044103e44453dfa3546c (do not edit this line) */
diff --git a/src/main/java/compiler/tmlgrammar/ParseException.java b/src/main/java/compiler/tmlgrammar/ParseException.java
index 996108acc3..4ccdd5457a 100644
--- a/src/main/java/compiler/tmlgrammar/ParseException.java
+++ b/src/main/java/compiler/tmlgrammar/ParseException.java
@@ -68,6 +68,9 @@ public class ParseException extends Exception {
* in the generated parser. Calling this constructor generates
* a new object of this type with the fields "currentToken",
* "expectedTokenSequences", and "tokenImage" set.
+ * @param tokenImageVal : token Image
+ * @param expectedTokenSequencesVal : expected token Sequences
+ * @param currentTokenVal : current token
*/
public ParseException(Token currentTokenVal,
int[][] expectedTokenSequencesVal,
@@ -94,7 +97,7 @@ public class ParseException extends Exception {
super();
}
- /** Constructor with message. */
+ /* Constructor with message. */
public ParseException(String message) {
super(message);
}
diff --git a/src/main/java/compiler/tmlgrammar/SimpleCharStream.java b/src/main/java/compiler/tmlgrammar/SimpleCharStream.java
index 824ff28954..de854ef224 100644
--- a/src/main/java/compiler/tmlgrammar/SimpleCharStream.java
+++ b/src/main/java/compiler/tmlgrammar/SimpleCharStream.java
@@ -172,7 +172,7 @@ public class SimpleCharStream
}
}
-/** Start. */
+/* Start. */
public char BeginToken() throws java.io.IOException
{
tokenBegin = -1;
@@ -222,7 +222,7 @@ public class SimpleCharStream
bufcolumn[bufpos] = column;
}
-/** Read a character. */
+/* Read a character. */
public char readChar() throws java.io.IOException
{
if (inBuf > 0)
@@ -264,27 +264,38 @@ public class SimpleCharStream
return bufline[bufpos];
}
- /** Get token end column number. */
+ /**
+ * @return : Get token end column number
+ */
public int getEndColumn() {
return bufcolumn[bufpos];
}
- /** Get token end line number. */
+ /**
+ * @return : Get token end line number
+ */
public int getEndLine() {
return bufline[bufpos];
}
- /** Get token beginning column number. */
+ /**
+ * @return : Get token beginning column number
+ */
public int getBeginColumn() {
return bufcolumn[tokenBegin];
}
- /** Get token beginning line number. */
+ /**
+ * @return : Get token beginning line number
+ */
public int getBeginLine() {
return bufline[tokenBegin];
}
-/** Backup a number of characters. */
+ /**
+ * Backup a number of characters
+ * @param amount : number of characters
+ */
public void backup(int amount) {
inBuf += amount;
@@ -292,7 +303,7 @@ public class SimpleCharStream
bufpos += bufsize;
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.Reader dstream, int startline,
int startcolumn, int buffersize)
{
@@ -306,20 +317,20 @@ public class SimpleCharStream
bufcolumn = new int[buffersize];
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.Reader dstream, int startline,
int startcolumn)
{
this(dstream, startline, startcolumn, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.Reader dstream)
{
this(dstream, 1, 1, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.Reader dstream, int startline,
int startcolumn, int buffersize)
{
@@ -339,96 +350,96 @@ public class SimpleCharStream
bufpos = -1;
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.Reader dstream, int startline,
int startcolumn)
{
ReInit(dstream, startline, startcolumn, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.Reader dstream)
{
ReInit(dstream, 1, 1, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, String encoding, int startline,
int startcolumn, int buffersize) throws java.io.UnsupportedEncodingException
{
this(encoding == null ? new java.io.InputStreamReader(dstream) : new java.io.InputStreamReader(dstream, encoding), startline, startcolumn, buffersize);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, int startline,
int startcolumn, int buffersize)
{
this(new java.io.InputStreamReader(dstream), startline, startcolumn, buffersize);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, String encoding, int startline,
int startcolumn) throws java.io.UnsupportedEncodingException
{
this(dstream, encoding, startline, startcolumn, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, int startline,
int startcolumn)
{
this(dstream, startline, startcolumn, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, String encoding) throws java.io.UnsupportedEncodingException
{
this(dstream, encoding, 1, 1, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream)
{
this(dstream, 1, 1, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, String encoding, int startline,
int startcolumn, int buffersize) throws java.io.UnsupportedEncodingException
{
ReInit(encoding == null ? new java.io.InputStreamReader(dstream) : new java.io.InputStreamReader(dstream, encoding), startline, startcolumn, buffersize);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, int startline,
int startcolumn, int buffersize)
{
ReInit(new java.io.InputStreamReader(dstream), startline, startcolumn, buffersize);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, String encoding) throws java.io.UnsupportedEncodingException
{
ReInit(dstream, encoding, 1, 1, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream)
{
ReInit(dstream, 1, 1, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, String encoding, int startline,
int startcolumn) throws java.io.UnsupportedEncodingException
{
ReInit(dstream, encoding, startline, startcolumn, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, int startline,
int startcolumn)
{
ReInit(dstream, startline, startcolumn, 4096);
}
- /** Get token literal value. */
+ /* Get token literal value. */
public String GetImage()
{
if (bufpos >= tokenBegin)
@@ -438,7 +449,7 @@ public class SimpleCharStream
new String(buffer, 0, bufpos + 1);
}
- /** Get the suffix. */
+ /* Get the suffix. */
public char[] GetSuffix(int len)
{
char[] ret = new char[len];
@@ -455,7 +466,7 @@ public class SimpleCharStream
return ret;
}
- /** Reset buffer when finished. */
+ /* Reset buffer when finished. */
public void Done()
{
buffer = null;
@@ -465,6 +476,8 @@ public class SimpleCharStream
/**
* Method to adjust line and column numbers for the start of a token.
+ * @param newCol : new column number
+ * @param newLine : new line number
*/
public void adjustBeginLineColumn(int newLine, int newCol)
{
diff --git a/src/main/java/compiler/tmlgrammar/TMLExprParser.java b/src/main/java/compiler/tmlgrammar/TMLExprParser.java
index 6af2c9184a..7f099d8a2b 100644
--- a/src/main/java/compiler/tmlgrammar/TMLExprParser.java
+++ b/src/main/java/compiler/tmlgrammar/TMLExprParser.java
@@ -63,7 +63,8 @@ public class TMLExprParser/*@bgen(jjtree)*/implements TMLExprParserTreeConstants
}
}
-/***************************************************
+/*
+ ***************************************************
* THE TML Expression LANGUAGE GRAMMAR STARTS HERE *
***************************************************/
@@ -221,7 +222,8 @@ public class TMLExprParser/*@bgen(jjtree)*/implements TMLExprParserTreeConstants
}
}
-/*************** NAT ****************/
+/*
+ ************** NAT ****************/
final public void NatExtendedExpression() throws ParseException {
/*@bgen(jjtree) NatExtendedExpression */
SimpleNode jjtn000 = new SimpleNode(JJTNATEXTENDEDEXPRESSION);
@@ -555,7 +557,9 @@ public class TMLExprParser/*@bgen(jjtree)*/implements TMLExprParserTreeConstants
}
}
-/********* QUEUE_NAT ***************/
+/*
+ ******************* QUEUE_NAT *******************
+ */
final public void QueueNatExtendedExpression() throws ParseException {
/*@bgen(jjtree) QueueNatExtendedExpression */
SimpleNode jjtn000 = new SimpleNode(JJTQUEUENATEXTENDEDEXPRESSION);
@@ -663,7 +667,9 @@ public class TMLExprParser/*@bgen(jjtree)*/implements TMLExprParserTreeConstants
}
}
-/********* BOOL ***************/
+/*
+ ************************ BOOL ***********************
+ */
final public void BoolExtendedExpression() throws ParseException {
/*@bgen(jjtree) BoolExtendedExpression */
SimpleNode jjtn000 = new SimpleNode(JJTBOOLEXTENDEDEXPRESSION);
@@ -2098,11 +2104,11 @@ void BoolExtendedExpressionAfterIDComparisonID() :
private boolean jj_rescan = false;
private int jj_gc = 0;
- /** Constructor with InputStream. */
+ /* Constructor with InputStream. */
public TMLExprParser(java.io.InputStream stream) {
this(stream, null);
}
- /** Constructor with InputStream and supplied encoding */
+ /* Constructor with InputStream and supplied encoding */
public TMLExprParser(java.io.InputStream stream, String encoding) {
try { jj_input_stream = new SimpleCharStream(stream, encoding, 1, 1); } catch(java.io.UnsupportedEncodingException e) { throw new RuntimeException(e); }
token_source = new TMLExprParserTokenManager(jj_input_stream);
@@ -2113,11 +2119,11 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream stream) {
ReInit(stream, null);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream stream, String encoding) {
try { jj_input_stream.ReInit(stream, encoding, 1, 1); } catch(java.io.UnsupportedEncodingException e) { throw new RuntimeException(e); }
token_source.ReInit(jj_input_stream);
@@ -2129,7 +2135,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Constructor. */
+ /* Constructor. */
public TMLExprParser(java.io.Reader stream) {
jj_input_stream = new SimpleCharStream(stream, 1, 1);
token_source = new TMLExprParserTokenManager(jj_input_stream);
@@ -2140,7 +2146,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.Reader stream) {
jj_input_stream.ReInit(stream, 1, 1);
token_source.ReInit(jj_input_stream);
@@ -2152,7 +2158,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Constructor with generated Token Manager. */
+ /* Constructor with generated Token Manager. */
public TMLExprParser(TMLExprParserTokenManager tm) {
token_source = tm;
token = new Token();
@@ -2162,7 +2168,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(TMLExprParserTokenManager tm) {
token_source = tm;
token = new Token();
@@ -2220,8 +2226,9 @@ void BoolExtendedExpressionAfterIDComparisonID() :
return false;
}
-
-/** Get the next Token. */
+ /**
+ * @return : Get the next Token
+ */
final public Token getNextToken() {
if (token.next != null) token = token.next;
else token = token.next = token_source.getNextToken();
@@ -2230,7 +2237,10 @@ void BoolExtendedExpressionAfterIDComparisonID() :
return token;
}
-/** Get the specific Token. */
+ /**
+ * @return : Get the specific Token
+ * @param index : index
+ */
final public Token getToken(int index) {
Token t = token;
for (int i = 0; i < index; i++) {
@@ -2278,7 +2288,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
}
}
- /** Generate ParseException. */
+ /** @return : Generate ParseException. */
public ParseException generateParseException() {
jj_expentries.clear();
boolean[] la1tokens = new boolean[89];
diff --git a/src/main/java/compiler/tmlgrammar/TMLExprParserTokenManager.java b/src/main/java/compiler/tmlgrammar/TMLExprParserTokenManager.java
index 14bd26f0bf..97799a7b10 100644
--- a/src/main/java/compiler/tmlgrammar/TMLExprParserTokenManager.java
+++ b/src/main/java/compiler/tmlgrammar/TMLExprParserTokenManager.java
@@ -50,7 +50,9 @@ public class TMLExprParserTokenManager implements TMLExprParserConstants
/** Debug output. */
public java.io.PrintStream debugStream = System.out;
- /** Set debug output. */
+ /** Set debug output.
+ * @param ds debug output
+ */
public void setDebugStream(java.io.PrintStream ds) { debugStream = ds; }
private final int jjStopStringLiteralDfa_0(int pos, long active0, long active1)
{
@@ -1191,20 +1193,20 @@ protected SimpleCharStream input_stream;
private final int[] jjrounds = new int[24];
private final int[] jjstateSet = new int[48];
protected char curChar;
-/** Constructor. */
+/* Constructor. */
public TMLExprParserTokenManager(SimpleCharStream stream){
if (SimpleCharStream.staticFlag)
throw new Error("ERROR: Cannot use a static CharStream class with a non-static lexical analyzer.");
input_stream = stream;
}
-/** Constructor. */
+/* Constructor. */
public TMLExprParserTokenManager(SimpleCharStream stream, int lexState){
this(stream);
SwitchTo(lexState);
}
-/** Reinitialise parser. */
+/* Reinitialise parser. */
public void ReInit(SimpleCharStream stream)
{
jjmatchedPos = jjnewStateCnt = 0;
@@ -1220,14 +1222,16 @@ private void ReInitRounds()
jjrounds[i] = 0x80000000;
}
-/** Reinitialise parser. */
+/* Reinitialise parser. */
public void ReInit(SimpleCharStream stream, int lexState)
{
ReInit(stream);
SwitchTo(lexState);
}
-/** Switch to specified lex state. */
+/** Switch to specified lex state
+ * @param lexState : lex state
+ */
public void SwitchTo(int lexState)
{
if (lexState >= 1 || lexState < 0)
@@ -1267,7 +1271,7 @@ int jjround;
int jjmatchedPos;
int jjmatchedKind;
-/** Get the next Token. */
+/** @return : Get the next Token. */
public Token getNextToken()
{
Token specialToken = null;
diff --git a/src/main/java/compiler/tmlgrammar/Token.java b/src/main/java/compiler/tmlgrammar/Token.java
index 2dea9a59ab..3e42a85cab 100644
--- a/src/main/java/compiler/tmlgrammar/Token.java
+++ b/src/main/java/compiler/tmlgrammar/Token.java
@@ -110,6 +110,7 @@ public class Token implements java.io.Serializable {
* interpreter. This attribute value is often different from the image.
* Any subclass of Token that actually wants to return a non-null value can
* override this method as appropriate.
+ * @return : always null
*/
public Object getValue() {
return null;
@@ -120,7 +121,7 @@ public class Token implements java.io.Serializable {
*/
public Token() {}
- /**
+ /*
* Constructs a new token for the specified Image.
*/
public Token(int kind)
@@ -128,7 +129,7 @@ public class Token implements java.io.Serializable {
this(kind, null);
}
- /**
+ /*
* Constructs a new token for the specified Image and Kind.
*/
public Token(int kind, String image)
@@ -138,7 +139,7 @@ public class Token implements java.io.Serializable {
}
/**
- * Returns the image.
+ * @return : the image.
*/
public String toString()
{
@@ -146,7 +147,7 @@ public class Token implements java.io.Serializable {
}
/**
- * Returns a new Token object, by default. However, if you want, you
+ * @return : a new Token object, by default. However, if you want, you
* can create and return subclass objects based on the value of ofKind.
* Simply add the cases to the switch for all those special cases.
* For example, if you have a subclass of Token called IDToken that
@@ -156,6 +157,8 @@ public class Token implements java.io.Serializable {
*
* to the following switch statement. Then you can cast matchedToken
* variable to the appropriate type and use sit in your lexical actions.
+ * @param ofKind : integer data
+ * @param image : image
*/
public static Token newToken(int ofKind, String image)
{
diff --git a/src/main/java/compiler/tmlgrammar/TokenMgrError.java b/src/main/java/compiler/tmlgrammar/TokenMgrError.java
index ddf00c2712..2403736b79 100644
--- a/src/main/java/compiler/tmlgrammar/TokenMgrError.java
+++ b/src/main/java/compiler/tmlgrammar/TokenMgrError.java
@@ -89,6 +89,8 @@ public class TokenMgrError extends Error
/**
* Replaces unprintable characters by their escaped (or unicode escaped)
* equivalents in the given string
+ * @param str : escaped characters
+ * @return : unprintable characters
*/
protected static final String addEscapes(String str) {
StringBuffer retval = new StringBuffer();
@@ -136,15 +138,15 @@ public class TokenMgrError extends Error
}
/**
- * Returns a detailed message for the Error when it is thrown by the
+ * @return : a detailed message for the Error when it is thrown by the
* token manager to indicate a lexical error.
* Parameters :
- * EOFSeen : indicates if EOF caused the lexical error
- * curLexState : lexical state in which this error occurred
- * errorLine : line number when the error occurred
- * errorColumn : column number when the error occurred
- * errorAfter : prefix that was seen before this error occurred
- * curchar : the offending character
+ * @param EOFSeen : indicates if EOF caused the lexical error
+ * @param lexState : lexical state in which this error occurred
+ * @param errorLine : line number when the error occurred
+ * @param errorColumn : column number when the error occurred
+ * @param errorAfter : prefix that was seen before this error occurred
+ * @param curChar : the offending character
* Note: You can customize the lexical error message by modifying this method.
*/
protected static String LexicalError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter, char curChar) {
@@ -163,6 +165,7 @@ public class TokenMgrError extends Error
* "Internal Error : Please file a bug report .... "
*
* from this method for such cases in the release version of your parser.
+ * @return : error messages
*/
public String getMessage() {
return super.getMessage();
@@ -176,13 +179,13 @@ public class TokenMgrError extends Error
public TokenMgrError() {
}
- /** Constructor with message and reason. */
+ /* Constructor with message and reason. */
public TokenMgrError(String message, int reason) {
super(message);
errorCode = reason;
}
- /** Full Constructor. */
+ /* Full Constructor. */
public TokenMgrError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter, char curChar, int reason) {
this(LexicalError(EOFSeen, lexState, errorLine, errorColumn, errorAfter, curChar), reason);
}
diff --git a/src/main/java/compiler/tmlparser/Node.java b/src/main/java/compiler/tmlparser/Node.java
index 8d479ba20b..20432a2777 100755
--- a/src/main/java/compiler/tmlparser/Node.java
+++ b/src/main/java/compiler/tmlparser/Node.java
@@ -60,20 +60,30 @@ interface Node {
added. */
void jjtClose();
- /** This pair of methods are used to inform the node of its
- parent. */
+ /**
+ * This pair of methods are used to inform the node of its parent
+ * @param n : node
+ */
void jjtSetParent(Node n);
Node jjtGetParent();
- /** This method tells the node to add its argument to the node's
- list of children. */
+ /**
+ * This method tells the node to add its argument to the node's list of children
+ * @param n : added node
+ * @param i : index of the added node in the node's list of children
+ */
void jjtAddChild(Node n, int i);
- /** This method returns a child node. The children are numbered
- from zero, left to right. */
+ /**
+ * This method returns a child node. The children are numbered from zero, left to right
+ * @param i : index of the child node
+ * @return : child node
+ */
Node jjtGetChild(int i);
- /** Return the number of children the node has. */
+ /**
+ * @return : the number of children the node has
+ */
int jjtGetNumChildren();
}
/* JavaCC - OriginalChecksum=51a365986f30b3d8da41a4f7d049ee04 (do not edit this line) */
diff --git a/src/main/java/compiler/tmlparser/ParseException.java b/src/main/java/compiler/tmlparser/ParseException.java
index 7ee2073a5e..04afb05fc1 100755
--- a/src/main/java/compiler/tmlparser/ParseException.java
+++ b/src/main/java/compiler/tmlparser/ParseException.java
@@ -69,6 +69,9 @@ public class ParseException extends Exception {
* in the generated parser. Calling this constructor generates
* a new object of this type with the fields "currentToken",
* "expectedTokenSequences", and "tokenImage" set.
+ * @param currentTokenVal current token
+ * @param expectedTokenSequencesVal expected token sequences
+ * @param tokenImageVal token image
*/
public ParseException(Token currentTokenVal,
int[][] expectedTokenSequencesVal,
@@ -95,7 +98,7 @@ public class ParseException extends Exception {
super();
}
- /** Constructor with message. */
+ /* Constructor with message. */
public ParseException(String message) {
super(message);
}
diff --git a/src/main/java/compiler/tmlparser/SimpleCharStream.java b/src/main/java/compiler/tmlparser/SimpleCharStream.java
index 6b64dd7153..a84bf56405 100755
--- a/src/main/java/compiler/tmlparser/SimpleCharStream.java
+++ b/src/main/java/compiler/tmlparser/SimpleCharStream.java
@@ -173,7 +173,7 @@ public class SimpleCharStream
}
}
-/** Start. */
+/* Start. */
public char BeginToken() throws java.io.IOException
{
tokenBegin = -1;
@@ -223,7 +223,7 @@ public class SimpleCharStream
bufcolumn[bufpos] = column;
}
-/** Read a character. */
+/* Read a character. */
public char readChar() throws java.io.IOException
{
if (inBuf > 0)
@@ -265,27 +265,37 @@ public class SimpleCharStream
return bufline[bufpos];
}
- /** Get token end column number. */
+ /**
+ * @return : Get token end column number.
+ */
public int getEndColumn() {
return bufcolumn[bufpos];
}
- /** Get token end line number. */
+ /**
+ * @return : Get token end line number
+ */
public int getEndLine() {
return bufline[bufpos];
}
- /** Get token beginning column number. */
+ /**
+ * @return : Get token beginning column number
+ */
public int getBeginColumn() {
return bufcolumn[tokenBegin];
}
- /** Get token beginning line number. */
+ /**
+ * @return : Get token beginning line number.
+ */
public int getBeginLine() {
return bufline[tokenBegin];
}
-
-/** Backup a number of characters. */
+ /**
+ * Backup a number of characters
+ * @param amount : number of characters
+ */
public void backup(int amount) {
inBuf += amount;
@@ -293,7 +303,7 @@ public class SimpleCharStream
bufpos += bufsize;
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.Reader dstream, int startline,
int startcolumn, int buffersize)
{
@@ -307,20 +317,20 @@ public class SimpleCharStream
bufcolumn = new int[buffersize];
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.Reader dstream, int startline,
int startcolumn)
{
this(dstream, startline, startcolumn, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.Reader dstream)
{
this(dstream, 1, 1, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.Reader dstream, int startline,
int startcolumn, int buffersize)
{
@@ -340,96 +350,96 @@ public class SimpleCharStream
bufpos = -1;
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.Reader dstream, int startline,
int startcolumn)
{
ReInit(dstream, startline, startcolumn, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.Reader dstream)
{
ReInit(dstream, 1, 1, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, String encoding, int startline,
int startcolumn, int buffersize) throws java.io.UnsupportedEncodingException
{
this(encoding == null ? new java.io.InputStreamReader(dstream) : new java.io.InputStreamReader(dstream, encoding), startline, startcolumn, buffersize);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, int startline,
int startcolumn, int buffersize)
{
this(new java.io.InputStreamReader(dstream), startline, startcolumn, buffersize);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, String encoding, int startline,
int startcolumn) throws java.io.UnsupportedEncodingException
{
this(dstream, encoding, startline, startcolumn, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, int startline,
int startcolumn)
{
this(dstream, startline, startcolumn, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream, String encoding) throws java.io.UnsupportedEncodingException
{
this(dstream, encoding, 1, 1, 4096);
}
- /** Constructor. */
+ /* Constructor. */
public SimpleCharStream(java.io.InputStream dstream)
{
this(dstream, 1, 1, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, String encoding, int startline,
int startcolumn, int buffersize) throws java.io.UnsupportedEncodingException
{
ReInit(encoding == null ? new java.io.InputStreamReader(dstream) : new java.io.InputStreamReader(dstream, encoding), startline, startcolumn, buffersize);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, int startline,
int startcolumn, int buffersize)
{
ReInit(new java.io.InputStreamReader(dstream), startline, startcolumn, buffersize);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, String encoding) throws java.io.UnsupportedEncodingException
{
ReInit(dstream, encoding, 1, 1, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream)
{
ReInit(dstream, 1, 1, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, String encoding, int startline,
int startcolumn) throws java.io.UnsupportedEncodingException
{
ReInit(dstream, encoding, startline, startcolumn, 4096);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream dstream, int startline,
int startcolumn)
{
ReInit(dstream, startline, startcolumn, 4096);
}
- /** Get token literal value. */
+ /* Get token literal value. */
public String GetImage()
{
if (bufpos >= tokenBegin)
@@ -439,7 +449,7 @@ public class SimpleCharStream
new String(buffer, 0, bufpos + 1);
}
- /** Get the suffix. */
+ /* Get the suffix. */
public char[] GetSuffix(int len)
{
char[] ret = new char[len];
@@ -466,6 +476,8 @@ public class SimpleCharStream
/**
* Method to adjust line and column numbers for the start of a token.
+ * @param newCol : new column number
+ * @param newLine : new line number
*/
public void adjustBeginLineColumn(int newLine, int newCol)
{
diff --git a/src/main/java/compiler/tmlparser/TMLExprParser.java b/src/main/java/compiler/tmlparser/TMLExprParser.java
index 0ce8ead3e4..2676e08245 100755
--- a/src/main/java/compiler/tmlparser/TMLExprParser.java
+++ b/src/main/java/compiler/tmlparser/TMLExprParser.java
@@ -64,7 +64,8 @@ public class TMLExprParser/*@bgen(jjtree)*/implements TMLExprParserTreeConstants
}
}
-/***************************************************
+/*
+ ***************************************************
* THE TML Expression LANGUAGE GRAMMAR STARTS HERE *
***************************************************/
@@ -222,7 +223,7 @@ public class TMLExprParser/*@bgen(jjtree)*/implements TMLExprParserTreeConstants
}
}
-/*************** NAT ****************/
+//*************** NAT ****************/
final public void NatExtendedExpression() throws ParseException {
/*@bgen(jjtree) NatExtendedExpression */
SimpleNode jjtn000 = new SimpleNode(JJTNATEXTENDEDEXPRESSION);
@@ -556,7 +557,7 @@ public class TMLExprParser/*@bgen(jjtree)*/implements TMLExprParserTreeConstants
}
}
-/********* QUEUE_NAT ***************/
+//********* QUEUE_NAT ***************/
final public void QueueNatExtendedExpression() throws ParseException {
/*@bgen(jjtree) QueueNatExtendedExpression */
SimpleNode jjtn000 = new SimpleNode(JJTQUEUENATEXTENDEDEXPRESSION);
@@ -664,7 +665,7 @@ public class TMLExprParser/*@bgen(jjtree)*/implements TMLExprParserTreeConstants
}
}
-/********* BOOL ***************/
+//********* BOOL ***************/
final public void BoolExtendedExpression() throws ParseException {
/*@bgen(jjtree) BoolExtendedExpression */
SimpleNode jjtn000 = new SimpleNode(JJTBOOLEXTENDEDEXPRESSION);
@@ -2099,11 +2100,11 @@ void BoolExtendedExpressionAfterIDComparisonID() :
private boolean jj_rescan = false;
private int jj_gc = 0;
- /** Constructor with InputStream. */
+ /* Constructor with InputStream. */
public TMLExprParser(java.io.InputStream stream) {
this(stream, null);
}
- /** Constructor with InputStream and supplied encoding */
+ /* Constructor with InputStream and supplied encoding */
public TMLExprParser(java.io.InputStream stream, String encoding) {
try { jj_input_stream = new SimpleCharStream(stream, encoding, 1, 1); } catch(java.io.UnsupportedEncodingException e) { throw new RuntimeException(e); }
token_source = new TMLExprParserTokenManager(jj_input_stream);
@@ -2114,11 +2115,11 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream stream) {
ReInit(stream, null);
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.InputStream stream, String encoding) {
try { jj_input_stream.ReInit(stream, encoding, 1, 1); } catch(java.io.UnsupportedEncodingException e) { throw new RuntimeException(e); }
token_source.ReInit(jj_input_stream);
@@ -2130,7 +2131,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Constructor. */
+ /* Constructor. */
public TMLExprParser(java.io.Reader stream) {
jj_input_stream = new SimpleCharStream(stream, 1, 1);
token_source = new TMLExprParserTokenManager(jj_input_stream);
@@ -2141,7 +2142,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(java.io.Reader stream) {
jj_input_stream.ReInit(stream, 1, 1);
token_source.ReInit(jj_input_stream);
@@ -2153,7 +2154,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Constructor with generated Token Manager. */
+ /* Constructor with generated Token Manager. */
public TMLExprParser(TMLExprParserTokenManager tm) {
token_source = tm;
token = new Token();
@@ -2163,7 +2164,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
for (int i = 0; i < jj_2_rtns.length; i++) jj_2_rtns[i] = new JJCalls();
}
- /** Reinitialise. */
+ /* Reinitialise. */
public void ReInit(TMLExprParserTokenManager tm) {
token_source = tm;
token = new Token();
@@ -2222,7 +2223,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
}
-/** Get the next Token. */
+/** @return : Get the next Token. */
final public Token getNextToken() {
if (token.next != null) token = token.next;
else token = token.next = token_source.getNextToken();
@@ -2231,7 +2232,10 @@ void BoolExtendedExpressionAfterIDComparisonID() :
return token;
}
-/** Get the specific Token. */
+ /**
+ * @return : Get the specific Token
+ * @param index : index
+ */
final public Token getToken(int index) {
Token t = token;
for (int i = 0; i < index; i++) {
@@ -2279,7 +2283,7 @@ void BoolExtendedExpressionAfterIDComparisonID() :
}
}
- /** Generate ParseException. */
+ /** @return : Generate ParseException. */
public ParseException generateParseException() {
jj_expentries.clear();
boolean[] la1tokens = new boolean[89];
diff --git a/src/main/java/compiler/tmlparser/TMLExprParserTokenManager.java b/src/main/java/compiler/tmlparser/TMLExprParserTokenManager.java
index f0ad5d7203..7f5dc4cfa1 100755
--- a/src/main/java/compiler/tmlparser/TMLExprParserTokenManager.java
+++ b/src/main/java/compiler/tmlparser/TMLExprParserTokenManager.java
@@ -52,7 +52,9 @@ public class TMLExprParserTokenManager implements TMLExprParserConstants
/** Debug output. */
public java.io.PrintStream debugStream = System.out;
- /** Set debug output. */
+ /** Set debug output.
+ * @param ds debug output
+ */
public void setDebugStream(java.io.PrintStream ds) { debugStream = ds; }
private final int jjStopStringLiteralDfa_0(int pos, long active0, long active1)
{
@@ -1193,20 +1195,20 @@ protected SimpleCharStream input_stream;
private final int[] jjrounds = new int[24];
private final int[] jjstateSet = new int[48];
protected char curChar;
-/** Constructor. */
+/* Constructor. */
public TMLExprParserTokenManager(SimpleCharStream stream){
if (SimpleCharStream.staticFlag)
throw new Error("ERROR: Cannot use a static CharStream class with a non-static lexical analyzer.");
input_stream = stream;
}
-/** Constructor. */
+/* Constructor. */
public TMLExprParserTokenManager(SimpleCharStream stream, int lexState){
this(stream);
SwitchTo(lexState);
}
-/** Reinitialise parser. */
+/* Reinitialise parser. */
public void ReInit(SimpleCharStream stream)
{
jjmatchedPos = jjnewStateCnt = 0;
@@ -1222,14 +1224,16 @@ private void ReInitRounds()
jjrounds[i] = 0x80000000;
}
-/** Reinitialise parser. */
+/* Reinitialise parser. */
public void ReInit(SimpleCharStream stream, int lexState)
{
ReInit(stream);
SwitchTo(lexState);
}
-/** Switch to specified lex state. */
+/** Switch to specified lex state.
+ * @param lexState : lex State
+ */
public void SwitchTo(int lexState)
{
if (lexState >= 1 || lexState < 0)
@@ -1269,7 +1273,7 @@ int jjround;
int jjmatchedPos;
int jjmatchedKind;
-/** Get the next Token. */
+/** @return : Get the next Token. */
public Token getNextToken()
{
Token specialToken = null;
diff --git a/src/main/java/compiler/tmlparser/Token.java b/src/main/java/compiler/tmlparser/Token.java
index 6e36464fd0..d982fb4a01 100755
--- a/src/main/java/compiler/tmlparser/Token.java
+++ b/src/main/java/compiler/tmlparser/Token.java
@@ -111,6 +111,7 @@ public class Token implements java.io.Serializable {
* interpreter. This attribute value is often different from the image.
* Any subclass of Token that actually wants to return a non-null value can
* override this method as appropriate.
+ * @return : always null
*/
public Object getValue() {
return null;
@@ -121,7 +122,7 @@ public class Token implements java.io.Serializable {
*/
public Token() {}
- /**
+ /*
* Constructs a new token for the specified Image.
*/
public Token(int kind)
@@ -129,7 +130,7 @@ public class Token implements java.io.Serializable {
this(kind, null);
}
- /**
+ /*
* Constructs a new token for the specified Image and Kind.
*/
public Token(int kind, String image)
@@ -139,7 +140,7 @@ public class Token implements java.io.Serializable {
}
/**
- * Returns the image.
+ * @return : the image.
*/
public String toString()
{
@@ -147,7 +148,7 @@ public class Token implements java.io.Serializable {
}
/**
- * Returns a new Token object, by default. However, if you want, you
+ * @return : a new Token object, by default. However, if you want, you
* can create and return subclass objects based on the value of ofKind.
* Simply add the cases to the switch for all those special cases.
* For example, if you have a subclass of Token called IDToken that
@@ -157,6 +158,8 @@ public class Token implements java.io.Serializable {
*
* to the following switch statement. Then you can cast matchedToken
* variable to the appropriate type and use sit in your lexical actions.
+ * @param ofKind : integer data
+ * @param image : image
*/
public static Token newToken(int ofKind, String image)
{
diff --git a/src/main/java/compiler/tmlparser/TokenMgrError.java b/src/main/java/compiler/tmlparser/TokenMgrError.java
index 9186a5ff4b..f73fdefeb6 100755
--- a/src/main/java/compiler/tmlparser/TokenMgrError.java
+++ b/src/main/java/compiler/tmlparser/TokenMgrError.java
@@ -90,6 +90,8 @@ public class TokenMgrError extends Error
/**
* Replaces unprintable characters by their escaped (or unicode escaped)
* equivalents in the given string
+ * @param str : escaped characters
+ * @return : unprintable characters
*/
protected static final String addEscapes(String str) {
StringBuffer retval = new StringBuffer();
@@ -137,15 +139,15 @@ public class TokenMgrError extends Error
}
/**
- * Returns a detailed message for the Error when it is thrown by the
+ * @return : a detailed message for the Error when it is thrown by the
* token manager to indicate a lexical error.
* Parameters :
- * EOFSeen : indicates if EOF caused the lexical error
- * curLexState : lexical state in which this error occurred
- * errorLine : line number when the error occurred
- * errorColumn : column number when the error occurred
- * errorAfter : prefix that was seen before this error occurred
- * curchar : the offending character
+ * @param EOFSeen : indicates if EOF caused the lexical error
+ * @param lexState : lexical state in which this error occurred
+ * @param errorLine : line number when the error occurred
+ * @param errorColumn : column number when the error occurred
+ * @param errorAfter : prefix that was seen before this error occurred
+ * @param curChar : the offending character
* Note: You can customize the lexical error message by modifying this method.
*/
protected static String LexicalError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter, char curChar) {
@@ -164,6 +166,7 @@ public class TokenMgrError extends Error
* "Internal Error : Please file a bug report .... "
*
* from this method for such cases in the release version of your parser.
+ * @return : error messages
*/
public String getMessage() {
return super.getMessage();
@@ -177,13 +180,13 @@ public class TokenMgrError extends Error
public TokenMgrError() {
}
- /** Constructor with message and reason. */
+ /* Constructor with message and reason. */
public TokenMgrError(String message, int reason) {
super(message);
errorCode = reason;
}
- /** Full Constructor. */
+ /* Full Constructor. */
public TokenMgrError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter, char curChar, int reason) {
this(LexicalError(EOFSeen, lexState, errorLine, errorColumn, errorAfter, curChar), reason);
}
diff --git a/src/main/java/myutil/AESEncryptor.java b/src/main/java/myutil/AESEncryptor.java
index f8244ac48f..8193a669d6 100644
--- a/src/main/java/myutil/AESEncryptor.java
+++ b/src/main/java/myutil/AESEncryptor.java
@@ -47,8 +47,6 @@ import javax.crypto.spec.SecretKeySpec;
/**
* Code taken initially taken from stack overflow
- * <p>
- * <p>
* Class AESEncryptor
* For remote execution of processes
* Creation: 2015
diff --git a/src/main/java/myutil/Conversion.java b/src/main/java/myutil/Conversion.java
index 18e33ab0ec..835fa112d2 100644
--- a/src/main/java/myutil/Conversion.java
+++ b/src/main/java/myutil/Conversion.java
@@ -604,6 +604,11 @@ public class Conversion {
/**
* Returns the index of the corresponding closing parenthesis.
* indexFirst corresponds to the indexd of the open parenthesis
+ * @param closePar : closing parenthesis
+ * @param expr : string
+ * @param indexFirst : index of the corresponding open parenthesis
+ * @param openPar : open parenthesis
+ * @return : index of the corresponding closing parenthesis
*/
public static int findMatchingParenthesis(String expr, int indexFirst, char openPar, char closePar) {
int index = indexFirst + 1;
diff --git a/src/main/java/myutil/externalSearch/Client.java b/src/main/java/myutil/externalSearch/Client.java
index 7f8fb11200..849888bba9 100644
--- a/src/main/java/myutil/externalSearch/Client.java
+++ b/src/main/java/myutil/externalSearch/Client.java
@@ -175,7 +175,7 @@ public class Client {
/**
* @param cmd strings in Message class.
* @param options list of options corresponds to list of values.
- * @param values
+ * @param values list of values
* @return Message.
*/
public Message createRequestMessage(String cmd, ArrayList<String> options, ArrayList<String> values) {
@@ -187,9 +187,10 @@ public class Client {
* @param msg Message
* @param server server address
* @param port port of service
+ * @param ssl ssl socket (Secure Sockets Layer)
* @return Message from Server.
- * @throws IOException
- * @throws ClassNotFoundException
+ * @throws IOException : I/O exception
+ * @throws ClassNotFoundException : ClassNotFoundException
*/
public Message send(Message msg, String server, int port, boolean ssl) throws IOException, ClassNotFoundException {
diff --git a/src/main/java/translator/ActivityDiagram.java b/src/main/java/translator/ActivityDiagram.java
index 93c2666599..40cee49427 100755
--- a/src/main/java/translator/ActivityDiagram.java
+++ b/src/main/java/translator/ActivityDiagram.java
@@ -203,7 +203,8 @@ public class ActivityDiagram extends Vector<ADComponent>{
}
- /** g !expr1 ...!exprn ?exprn+1 ...?exprn+m -> g!expr1...!exprn followed by g?exprn+1 ...?exprn+m
+ /** g !expr1 ...!exprn ?exprn+1 ...?exprn+m to g!expr1...!exprn followed by g?exprn+1 ...?exprn+m
+ * @param g : Gate
*/
public void distinguishAllCallOn(Gate g) {
ADComponent adc;
diff --git a/src/main/java/ui/AbstractCDElement.java b/src/main/java/ui/AbstractCDElement.java
index afd37aeedc..78dcc2bae0 100644
--- a/src/main/java/ui/AbstractCDElement.java
+++ b/src/main/java/ui/AbstractCDElement.java
@@ -10,7 +10,7 @@ public abstract class AbstractCDElement implements CDElement {
/**
* Issue #69
- * @param _enabled
+ * @param _enabled : boolean data type
*/
@Override
public void setEnabled( final boolean _enabled ) {
@@ -19,7 +19,7 @@ public abstract class AbstractCDElement implements CDElement {
/**
* Issue #69
- * @param _enabled
+ * @param _enabled : boolean data type
*/
@Override
public void doSetEnabled( final boolean _enabled ) {
@@ -38,16 +38,17 @@ public abstract class AbstractCDElement implements CDElement {
/**
* Issue #69
- * @return
+ * @return : Always False
*/
@Override
public boolean canBeDisabled() {
return false;
}
- /**
+ /**
* Issue #69
- * @return
+ * @param label : Label
+ * @return : Always False
*/
@Override
public boolean canLabelBeDisabled( TGCOneLineText label ) {
diff --git a/src/main/java/ui/TDiagramPanel.java b/src/main/java/ui/TDiagramPanel.java
index 7fc566a0e7..484f4c1086 100644
--- a/src/main/java/ui/TDiagramPanel.java
+++ b/src/main/java/ui/TDiagramPanel.java
@@ -3978,7 +3978,7 @@ public abstract class TDiagramPanel extends JPanel implements GenericTree {
/**
* Check if newvalue is already a name of a component.
*
- * @param newvalue
+ * @param newvalue : Checked name value
* @return true if the name is used
* @author Fabien Tessier
*/
diff --git a/src/main/java/ui/TGComponent.java b/src/main/java/ui/TGComponent.java
index 2447fcf1c7..f7578a188c 100644
--- a/src/main/java/ui/TGComponent.java
+++ b/src/main/java/ui/TGComponent.java
@@ -2842,6 +2842,9 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDElem
* Highlight the selected component
*
* @author Fabien Tessier
+ * @param frame : Unused
+ * @param x : X position
+ * @param y : Y position
*/
public final void singleClick(JFrame frame, int x, int y) {
isSelect = true;
@@ -3357,8 +3360,8 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDElem
/**
* Issue #69
- * @param point
- * @return
+ * @param point : connecting point
+ * @return : Connector
*/
public TGConnector getConnectorConnectedTo( final TGConnectingPoint point ) {
return tdp.getConnectorConnectedTo( point );
@@ -3366,7 +3369,7 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDElem
/**
* Issue #69
- * @return
+ * @return : List of connectors
*/
public List<TGConnector> getConnectors() {
return tdp.getConnectors();
@@ -3374,7 +3377,7 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDElem
/**
* Issue #69
- * @return
+ * @return : List of connectors
*/
public List<TGConnector> getInputConnectors() {
final List<TGConnector> connectors = new ArrayList<TGConnector>();
@@ -3391,7 +3394,7 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDElem
/**
* Issue #69
- * @return
+ * @return : List of output connectors
*/
public List<TGConnector> getOutputConnectors() {
final List<TGConnector> connectors = new ArrayList<TGConnector>();
@@ -3408,7 +3411,7 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDElem
/**
* Issue #69
- * @return
+ * @return : Array of connecting points
*/
public TGConnectingPoint[] getConnectingPoints() {
return connectingPoint;
diff --git a/src/main/java/ui/ad/TADChoice.java b/src/main/java/ui/ad/TADChoice.java
index 67361b576a..c5f064e56c 100755
--- a/src/main/java/ui/ad/TADChoice.java
+++ b/src/main/java/ui/ad/TADChoice.java
@@ -225,8 +225,8 @@ public class TADChoice extends TADComponentWithSubcomponents/* Issue #69 TGCWit
/**
* Issue #69
- * @param point
- * @return
+ * @param point : Connecting point
+ * @return : Guard of connecting point
*/
public TGCOneLineText getGuardForConnectingPoint( final TGConnectingPoint point ) {
final int index = Arrays.asList( connectingPoint ).indexOf( point );
@@ -263,7 +263,8 @@ public class TADChoice extends TADComponentWithSubcomponents/* Issue #69 TGCWit
/**
* Issue #69
- * @return
+ * @param label : TGOneLineText
+ * @return : true if label is neither null nor empty nor []
*/
@Override
public boolean canLabelBeDisabled( final TGCOneLineText label ) {
@@ -272,8 +273,8 @@ public class TADChoice extends TADComponentWithSubcomponents/* Issue #69 TGCWit
/**
* Issue #69
- * @param guard
- * @return
+ * @param guard : Guard value
+ * @return : Effective condition
*/
public String getEffectiveCondition( final TGCOneLineText guard ) {
if ( guard.isEnabled() ) {
diff --git a/src/main/java/ui/ad/TADComponentWithSubcomponents.java b/src/main/java/ui/ad/TADComponentWithSubcomponents.java
index 7faa2ecd2c..d667814cfd 100644
--- a/src/main/java/ui/ad/TADComponentWithSubcomponents.java
+++ b/src/main/java/ui/ad/TADComponentWithSubcomponents.java
@@ -18,7 +18,7 @@ public abstract class TADComponentWithSubcomponents extends TGCScalableWithInter
/**
* Issue #69
- * @return
+ * @return : true if can be able to disable ElementVisitor in Activity Diagram
*/
@Override
public boolean canBeDisabled() {
diff --git a/src/main/java/ui/ad/TADComponentWithoutSubcomponents.java b/src/main/java/ui/ad/TADComponentWithoutSubcomponents.java
index 2317c348b6..f55ad3d18a 100644
--- a/src/main/java/ui/ad/TADComponentWithoutSubcomponents.java
+++ b/src/main/java/ui/ad/TADComponentWithoutSubcomponents.java
@@ -18,7 +18,7 @@ public abstract class TADComponentWithoutSubcomponents extends TGCWithoutInterna
/**
* Issue #69
- * @return
+ * @return : true if can be able to disable ElementVisitor in Activity Diagram
*/
@Override
public boolean canBeDisabled() {
diff --git a/src/main/java/ui/ad/TADConnector.java b/src/main/java/ui/ad/TADConnector.java
index 8fc2736a95..073735931b 100644
--- a/src/main/java/ui/ad/TADConnector.java
+++ b/src/main/java/ui/ad/TADConnector.java
@@ -33,7 +33,7 @@ public abstract class TADConnector extends TGConnector {
/**
* Issue #69
- * @param _enabled
+ * @param _enabled : true for enabling the connector in Activity Diagram
*/
@Override
public void setEnabled( final boolean _enabled ) {
@@ -44,7 +44,7 @@ public abstract class TADConnector extends TGConnector {
/**
* Issue #69
- * @return
+ * @return : true if can be able to disable the Connector in Activity Diagram
*/
@Override
public boolean canBeDisabled() {
@@ -59,7 +59,7 @@ public abstract class TADConnector extends TGConnector {
}
/** Issue #69
- * @return
+ * @return : boolean value allows to verify the connector stage in Activity Diagram
*/
public boolean isEnabled( boolean checkBranch ) {
if ( checkBranch && p2 != null ) {
diff --git a/src/main/java/ui/ad/TADForLoop.java b/src/main/java/ui/ad/TADForLoop.java
index ebb66cde88..e0dafe7cf0 100644
--- a/src/main/java/ui/ad/TADForLoop.java
+++ b/src/main/java/ui/ad/TADForLoop.java
@@ -115,7 +115,7 @@ public abstract class TADForLoop extends TADComponentWithoutSubcomponents implem
/**
* Issue #69
- * @param _enabled
+ * @param _enabled : true for getting inside loop
*/
@Override
public void setEnabled( final boolean _enabled ) {
diff --git a/src/main/java/ui/ad/TADOneLineText.java b/src/main/java/ui/ad/TADOneLineText.java
index ffdc4a483f..db8fc5c86f 100644
--- a/src/main/java/ui/ad/TADOneLineText.java
+++ b/src/main/java/ui/ad/TADOneLineText.java
@@ -13,7 +13,7 @@ public abstract class TADOneLineText extends TGCOneLineText {
/**
* Issue #69
- * @return
+ * @return : True if OneLineText is able to disable
*/
@Override
public boolean canBeDisabled() {
diff --git a/src/main/java/ui/ad/TADSequence.java b/src/main/java/ui/ad/TADSequence.java
index 158a67935d..ffc07b425e 100755
--- a/src/main/java/ui/ad/TADSequence.java
+++ b/src/main/java/ui/ad/TADSequence.java
@@ -146,7 +146,7 @@ public class TADSequence extends TADComponentWithSubcomponents /* Issue #69 TGCW
/**
* Issue #69
- * @param _enabled
+ * @param _enabled : boolean data
*/
@Override
public void setEnabled( final boolean _enabled ) {
diff --git a/src/main/java/ui/avatarad/AvatarADAssociationConnector.java b/src/main/java/ui/avatarad/AvatarADAssociationConnector.java
index 56b3f58357..2db6fce8e8 100755
--- a/src/main/java/ui/avatarad/AvatarADAssociationConnector.java
+++ b/src/main/java/ui/avatarad/AvatarADAssociationConnector.java
@@ -88,7 +88,7 @@ public class AvatarADAssociationConnector extends TADConnector/* Issue #69 TGCo
/**
* Issue #69
- * @return
+ * @return : true if can be able to disable Association Connector in Activity Diagram
*/
@Override
public boolean canBeDisabled() {
diff --git a/src/main/java/ui/avatarad/AvatarADParallel.java b/src/main/java/ui/avatarad/AvatarADParallel.java
index 0a583b4283..0a7b372c68 100755
--- a/src/main/java/ui/avatarad/AvatarADParallel.java
+++ b/src/main/java/ui/avatarad/AvatarADParallel.java
@@ -134,7 +134,7 @@ public class AvatarADParallel extends AvatarADBasicCanBeDisabledComponent /* Iss
/**
* Issue #69
- * @param _enabled
+ * @param _enabled : true for enabling the Parallel Operator
*/
@Override
public void setEnabled( final boolean _enabled ) {
diff --git a/src/main/java/ui/procsd/JDialogAttributeProCSD.java b/src/main/java/ui/procsd/JDialogAttributeProCSD.java
index f3f50e3118..551a883346 100644
--- a/src/main/java/ui/procsd/JDialogAttributeProCSD.java
+++ b/src/main/java/ui/procsd/JDialogAttributeProCSD.java
@@ -87,7 +87,7 @@ public class JDialogAttributeProCSD extends javax.swing.JDialog implements Actio
private JButton closeButton;
private JButton cancelButton;
- /** Creates new form */
+ /* Creates new form */
public JDialogAttributeProCSD(LinkedList<TAttribute> _attributes, LinkedList<TAttribute> _forbidden, Frame f, String title, String attrib) {
super(f, title, true);
diff --git a/src/main/java/ui/procsd/ProCSDPort.java b/src/main/java/ui/procsd/ProCSDPort.java
index bcdf54d33f..05c9e4f85d 100644
--- a/src/main/java/ui/procsd/ProCSDPort.java
+++ b/src/main/java/ui/procsd/ProCSDPort.java
@@ -504,9 +504,11 @@ public abstract class ProCSDPort extends TGCWithoutInternalComponent implements
//Method added by Solange
/** Allows to get all the messages of
- * a mandatory interface.
- * @param p port connected to the interface
- * @return msgMandatory Vector of messages
+ * a mandatory interface.
+ * @param p port connected to the interface
+ * @param it : interface
+ * @return msgMandatory Vector of messages
+ *
**/
public Vector<TAttribute> getMsgMandatory(ProCSDPort p, ProCSDInterface it){
Vector<TAttribute> msgMandatory=new Vector<TAttribute>();
diff --git a/webcrawler/client/src/main/java/web/crawler/Client.java b/webcrawler/client/src/main/java/web/crawler/Client.java
index d07404bb7a..a350edb5de 100644
--- a/webcrawler/client/src/main/java/web/crawler/Client.java
+++ b/webcrawler/client/src/main/java/web/crawler/Client.java
@@ -61,10 +61,10 @@ public class Client {
/**
*
- * @param cmd
- * @param options
- * @param values
- * @return
+ * @param cmd strings in Message class.
+ * @param options list of options corresponds to list of values.
+ * @param values list of values
+ * @return Message.
*/
public static Message createRequestMessage(String cmd, ArrayList<String> options, ArrayList<String> values) {
Message requestMsg = new Message(cmd, options, values);
@@ -73,8 +73,7 @@ public class Client {
}
/**
- *
- * @param answerMsg
+ * @param answerMsg the answer message from the server
*/
public static void analyseAnswerMessage(Message answerMsg) {
//Analyse the message from the server,
@@ -136,10 +135,6 @@ public class Client {
}
- /**
- *
- * @param args
- */
public static void main(String[] args) {
SSLSocket client = null;
--
GitLab