diff --git a/Makefile b/Makefile index b61047a788088d14c28307d21ad3777f387aa6ac..49d6674184b42e7a123298fad10ab4944bedcf13 100755 --- a/Makefile +++ b/Makefile @@ -221,7 +221,7 @@ html: $(MD2HTML) TTOOL_DOC = $(TTOOL_PATH)/doc export TTOOL_DOC_HTML = $(TTOOL_DOC)/html -DOCFLAGS = -encoding "UTF8" -quiet -J-Xmx256m -classpath $(TTOOL_CLASSPATH) -d $(TTOOL_DOC_HTML) +DOCFLAGS = -encoding "UTF8" -quiet -J-Xmx512m -classpath $(TTOOL_CLASSPATH) -d $(TTOOL_DOC_HTML) documentation: $(patsubst %,$(TTOOL_SRC)/%,$(GLOBAL_JAVA)) @echo "$(PREFIX) Generating Javadoc" diff --git a/src/main/java/myutil/RawConsoleInput.java b/src/main/java/myutil/RawConsoleInput.java index cbd7dfe34a579ef3737a14afb861f569f762ed5e..a0ae8c877cfd1844c41954e242807599f50c924e 100644 --- a/src/main/java/myutil/RawConsoleInput.java +++ b/src/main/java/myutil/RawConsoleInput.java @@ -29,8 +29,7 @@ import java.util.List; /** * A JNA based driver for reading single characters from the console. - * <p> - * <p>This class is used for console mode programs. + * This class is used for console mode programs. * It supports non-blocking reads of single key strokes without echo. */ public class RawConsoleInput { diff --git a/src/main/java/syscamstranslator/toSysCAMS/ClusterCode.java b/src/main/java/syscamstranslator/toSysCAMS/ClusterCode.java index ae724dceecae066c89892f502ff552c35841a0c3..36456ed61877602da3d25300d72ebec5d0975a50 100644 --- a/src/main/java/syscamstranslator/toSysCAMS/ClusterCode.java +++ b/src/main/java/syscamstranslator/toSysCAMS/ClusterCode.java @@ -50,9 +50,8 @@ import syscamstranslator.*; * Class ClusterCode Principal code of a cluster component Creation: 14/05/2018 * * @version 1.0 14/05/2018 - * @author Irina Kit Yan LEE, + * @author Irina Kit Yan LEE, Daniela GENIUS * @version 1.1 30/09/2019 - * @modified Daniela GENIUS */ public class ClusterCode { diff --git a/src/main/java/ui/TGComponent.java b/src/main/java/ui/TGComponent.java index 86dbad068abab3b7ba2864da744053740972337c..ccaeff929e44c144de8940fbd7695ab3ef73bf7f 100644 --- a/src/main/java/ui/TGComponent.java +++ b/src/main/java/ui/TGComponent.java @@ -1047,7 +1047,6 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDEleme /** * Issue #31 * - * @return */ protected int getReachabilityMargin() { return 18; @@ -1056,7 +1055,6 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDEleme /** * Issue #31 * - * @return */ protected int getLivenessMargin() { return 10; @@ -1065,7 +1063,6 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDEleme /** * Issue #31 * - * @return */ protected int getUnknownMargin() { return 2; @@ -1074,7 +1071,6 @@ public abstract class TGComponent extends AbstractCDElement implements /*CDEleme /** * Issue #31 * - * @return */ protected int getExclusionMargin() { return 12; diff --git a/src/main/java/ui/TGConnectorWithCommentConnectionPoints.java b/src/main/java/ui/TGConnectorWithCommentConnectionPoints.java index 330535a232e05de4aa137284bf4f6297397c92b5..f65c1a5916dd6af676b0d498bc37ac36981e756c 100644 --- a/src/main/java/ui/TGConnectorWithCommentConnectionPoints.java +++ b/src/main/java/ui/TGConnectorWithCommentConnectionPoints.java @@ -97,7 +97,6 @@ public abstract class TGConnectorWithCommentConnectionPoints extends TGConnector } /** * setP2: destination point - * @param TGConnectingPoint p */ @Override public void setP2(TGConnectingPoint p) { diff --git a/src/main/java/ui/TGScalableComponent.java b/src/main/java/ui/TGScalableComponent.java index 532e04d8677bc019f429a003eb1e94c6735f4f7c..baa30b906ebe0e76a7e0de4154f4e1d2f98a9641 100644 --- a/src/main/java/ui/TGScalableComponent.java +++ b/src/main/java/ui/TGScalableComponent.java @@ -59,7 +59,7 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl * Verifies that the text is readable if its not it shall not be drawn * fontsize 8 is the limit that is set to be "readable". It can be changed * @param g - * @return + * @return whether textSize is greater than 7 */ protected boolean isTextReadable(Graphics g) { int textSize = g.getFont().getSize(); @@ -70,7 +70,7 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl * Gets the center of the rectangle/box * @param g * @param str - * @return + * @return the center */ protected int getCenter(Graphics g, String str) { @@ -82,10 +82,10 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl * Verifies that the text is small enough to be drawn into the box * If The actual box does not have an icon, make sure call the function as following: * canTextGoInTheBox(g, fontSize, text, 0); - * @param g - * @param fontSize - * @param text - * @param iconSize + * @param g the graphics + * @param fontSize the size of the font to be used + * @param text the text to be displayed + * @param iconSize the size of the icon * @return a boolean indicating that the txt can or not be drawn */ protected boolean canTextGoInTheBox(Graphics g, int fontSize, String text, int iconSize) @@ -99,8 +99,8 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Draw a box of two rectangle: one for the title and one for the content of the box * lineHeight defines the height of the first box - * @param g - * @param lineHeight + * @param g the graphics to use + * @param lineHeight is the current line height */ protected void drawDoubleRectangleBoxType(Graphics g, int lineHeight, Color cbefore, Color cafter) { @@ -117,7 +117,7 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl } /** * Draw one box without any color filling - * @param g + * @param g the graphics */ protected void drawSimpleRectangle(Graphics g) { @@ -126,9 +126,9 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * used to draw the icon "icon" at position x = x + width - scale(iconsize) - borders * and y = y + borders - * @param g - * @param icon - * @param iconSize + * @param g the graphics + * @param icon the icon + * @param iconSize the size of the icon */ protected void drawIcon(Graphics g, Image icon, int iconSize) { if (!isTextReadable(g)) @@ -142,10 +142,11 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl return; g.drawImage(scale(image), xpos, ypos, null); } + /** * Draw string if text is readable - * @param g - * @param s + * @param g the graphics used to print the string + * @param s the String to be printed */ protected void drawSingleString(Graphics g, String s, int xpos, int ypos) { @@ -157,12 +158,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Same as drawSingleString - * @param g - * @param s - * @param xpos - * @param ypos - * @param maxWidth - * @param pos */ protected void drawSingleLimitedString(Graphics g, String s, int xpos, int ypos, int maxWidth, int pos) { @@ -173,10 +168,7 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * draw two string one under another: - * - * @param g - * @param topText - * @param bottomText + * */ protected void drawDoubleLimitedString(Graphics g, String topText, String bottomText) { @@ -194,10 +186,7 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * draw two string one under another: - * - * @param g - * @param topText - * @param bottomText + * */ protected void drawDoubleString(Graphics g, String topText, String bottomText) { @@ -216,8 +205,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Scale from a value and a factor - * @param value - * @param factor * @return scaling value of param: value and factor * */ public static int scale( final int value, @@ -253,7 +240,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Scale from a value and the oldScaleFactor previously saved - * @param value * @return scaling value of param: value and oldScaleFactor * */ protected int scale( final int value ) { @@ -328,7 +314,7 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * force a scale to a given ratio - * @param factor + * @param factor the factor of the zoom * * */ @@ -508,7 +494,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Issue #31 - * @return */ @Override protected int getReachabilityMargin() { @@ -517,7 +502,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Issue #31 - * @return */ @Override protected int getLivenessMargin() { @@ -526,7 +510,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Issue #31 - * @return */ @Override protected int getExclusionMargin() { @@ -535,7 +518,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Issue #31 - * @return */ protected int getUnknownMargin() { return scale( super.getUnknownMargin() ); @@ -543,7 +525,7 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Issue #31: Shared this check - * @param graphics + * @param graphics the graphics used to check for the width */ protected int checkWidth( final Graphics graphics ) { return checkWidth( graphics, value ); @@ -552,8 +534,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Issue #31: Check the Width, increase the width in case the actual width is not enough to display the text. * Used when a component is created - * @param graphics - * @param text * @return textWidth * */ protected int checkWidth( final Graphics graphics, @@ -571,7 +551,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Scale an image directly - * @param image * @return the scaled image * */ protected Image scale( final Image image ) { @@ -584,8 +563,6 @@ public abstract class TGScalableComponent extends TGComponent implements Scalabl /** * Scale an image directly with a custom width - * @param image - * @param width * @return the scaled image * */ protected Image scale( final Image image, diff --git a/src/main/java/ui/avatarpd/AvatarPDBlock.java b/src/main/java/ui/avatarpd/AvatarPDBlock.java index 3486d59672dc17fdd8db209f87e3f01a82693734..912d555e544bd78f977214a830e5207555df2285 100644 --- a/src/main/java/ui/avatarpd/AvatarPDBlock.java +++ b/src/main/java/ui/avatarpd/AvatarPDBlock.java @@ -137,15 +137,6 @@ public class AvatarPDBlock extends TGCScalableWithInternalComponent implements S actionOnAdd(); } - /** - * will get the position which represent the center of the box - * we are drawing. It will use the stringWidth so that the center is - * calculated in function of the string we want to draw. - * this function is used in internalDrawing - * @param g - * @param str - * @return - */ @Override diff --git a/src/main/java/ui/sysmlv2/MyStyledEditorKit.java b/src/main/java/ui/sysmlv2/MyStyledEditorKit.java index 706555d9f9cc0f7f76abfd74ee0c519d1e000ec1..8c6e2d4e0995f2b2934799a7faa37e74828a5e42 100644 --- a/src/main/java/ui/sysmlv2/MyStyledEditorKit.java +++ b/src/main/java/ui/sysmlv2/MyStyledEditorKit.java @@ -49,7 +49,7 @@ import myutil.*; * Creation: 15/07/2021 * Version 1.0 15/07/2021 * @author Ludovic APVRILLE - * @see + * @see StyledEditorKit */ public class MyStyledEditorKit extends StyledEditorKit { diff --git a/src/main/java/ui/tmldd/TMLArchiFirewallNode.java b/src/main/java/ui/tmldd/TMLArchiFirewallNode.java index e45d23a2f4f55ab098b48983c726192cbe984747..22d941c68e98ab16659758345f51a952c5465d89 100644 --- a/src/main/java/ui/tmldd/TMLArchiFirewallNode.java +++ b/src/main/java/ui/tmldd/TMLArchiFirewallNode.java @@ -59,7 +59,7 @@ import java.util.List; * Node. To be used in TML architecture diagrams. * Creation: 17/10/2016 * @version 1.0 17/10/2016 - * @author Letitia LI <3 + * @author Letitia LI */ public class TMLArchiFirewallNode extends TMLArchiCommunicationNode implements SwallowTGComponent, WithAttributes, TMLArchiSecurityInterface {