Fix javadoc issues

gephi · Nov 26, 2018 · 0075009098070801f437656c7441ca65c4d1b8d7 · 0075009
1 parent 193fa53
commit 0075009098070801f437656c7441ca65c4d1b8d7
diff --git a/...aboratoryPlugin/src/main/java/org/gephi/datalab/plugin/manipulators/nodes/MergeNodes.java b/...aboratoryPlugin/src/main/java/org/gephi/datalab/plugin/manipulators/nodes/MergeNodes.java
@@ -61,15 +61,13 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 * <p>Nodes manipulator that merges 2 or more nodes</p>
- * <p>
 * The behaviour is:
 * <ul>
 * <li>Merged nodes are deleted if desired, and one new node is created</li>
 * <li>Edges of all the nodes are assigned to the new node</li>
 * <li>Each column uses an strategy to reduce the rows values to one value</li>
 * <li></li>
 * </ul>
- * </p>
 * @author Eduardo Ramos
 */
 public class MergeNodes extends BasicNodesManipulator {
diff --git a/...in/java/org/gephi/desktop/datalab/tables/celleditors/AttributeTypesSupportCellEditor.java b/...in/java/org/gephi/desktop/datalab/tables/celleditors/AttributeTypesSupportCellEditor.java
@@ -49,7 +49,6 @@ Development and Distribution License("CDDL") (collectively, the
 import javax.swing.border.Border;
 import javax.swing.border.LineBorder;
 import org.gephi.desktop.datalab.utils.GraphModelProvider;
-import org.gephi.desktop.datalab.utils.stringconverters.DoubleStringConverter;
 import org.gephi.graph.api.AttributeUtils;
 import org.gephi.graph.api.TimeFormat;
 import org.gephi.graph.api.types.IntervalMap;
@@ -60,7 +59,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Eduardo Ramos<eduramiba@gmail.com>
+ * @author Eduardo Ramos
 */
 public class AttributeTypesSupportCellEditor extends DefaultCellEditor {

diff --git a/...s/DesktopPreview/src/main/java/org/gephi/desktop/preview/PreviewSettingsTopComponent.java b/...s/DesktopPreview/src/main/java/org/gephi/desktop/preview/PreviewSettingsTopComponent.java
@@ -288,8 +288,6 @@ public float getVisibilityRatio() {

    /**
     * Enables the refresh button.
-     *
-     * @see PreviewUIController#enableRefresh()
     */
    public void enableRefreshButton() {
        refreshButton.setEnabled(true);
@@ -302,8 +300,6 @@ public void enableRefreshButton() {

    /**
     * Disables the refresh button.
-     *
-     * @see PreviewUIController#disableRefresh()
     */
    public void disableRefreshButton() {
        refreshButton.setEnabled(false);
diff --git a/modules/DesktopPreview/src/main/java/org/gephi/desktop/preview/PreviewTopComponent.form b/modules/DesktopPreview/src/main/java/org/gephi/desktop/preview/PreviewTopComponent.form
@@ -86,9 +86,6 @@
      <SubComponents>
        <Container class="javax.swing.JPanel" name="sketchPanel">
          <Properties>
-            <Property name="background" type="java.awt.Color" editor="org.netbeans.beaninfo.editors.ColorEditor">
-              <Color blue="ff" green="ff" red="ff" type="rgb"/>
-            </Property>
            <Property name="preferredSize" type="java.awt.Dimension" editor="org.netbeans.beaninfo.editors.DimensionEditor">
              <Dimension value="[500, 500]"/>
            </Property>
diff --git a/modules/DesktopPreview/src/main/java/org/gephi/desktop/preview/PreviewTopComponent.java b/modules/DesktopPreview/src/main/java/org/gephi/desktop/preview/PreviewTopComponent.java
@@ -221,8 +221,6 @@ public void initTarget(PreviewUIModel previewUIModel) {

    /**
     * Shows the banner panel.
-     *
-     * @see PreviewUIController#showRefreshNotification()
     */
    public void showBannerPanel() {
        SwingUtilities.invokeLater(new Runnable() {
@@ -239,8 +237,6 @@ public void setBackgroundColor(Color color) {

    /**
     * Hides the banner panel.
-     *
-     * @see PreviewUIController#hideRefreshNotification()
     */
    public void hideBannerPanel() {
        SwingUtilities.invokeLater(new Runnable() {
diff --git a/modules/DesktopProgress/src/main/java/org/gephi/desktop/progress/ProgressTicketImpl.java b/modules/DesktopProgress/src/main/java/org/gephi/desktop/progress/ProgressTicketImpl.java
@@ -82,7 +82,7 @@ public void finish() {

    /**
     * Finish the task and display a statusbar message
-     * @param finishMessage 
+     * @param finishMessage Finish message
     */
    @Override
    public void finish(String finishMessage) {
@@ -106,7 +106,7 @@ public void progress() {

    /**
     * Notify the user about completed workunits.
-     * @param a cumulative number of workunits completed so far
+     * @param workunit cumulative number of workunits completed so far
     */
    @Override
    public void progress(int workunit) {
@@ -122,7 +122,7 @@ public void progress(int workunit) {

    /**
     * Notify the user about progress by showing message with details.
-     * @param details about the status of the task
+     * @param message details about the status of the task
     */
    @Override
    public void progress(String message) {
diff --git a/modules/LayoutAPI/src/main/java/org/gephi/layout/spi/Layout.java b/modules/LayoutAPI/src/main/java/org/gephi/layout/spi/Layout.java
@@ -54,7 +54,7 @@ Development and Distribution License("CDDL") (collectively, the
 * properly define the various <code>LayoutProperty</code> returned by the
 * {@link #getProperties()} method and provide getter and setter for each.
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 * @see LayoutBuilder
 */
 public interface Layout {
@@ -93,7 +93,6 @@ Development and Distribution License("CDDL") (collectively, the
    /**
     * The properties for this layout.
     * @return              the layout properties
-     * @throws NoSuchMethodException 
     */
    public LayoutProperty[] getProperties();

diff --git a/modules/LayoutAPI/src/main/java/org/gephi/layout/spi/LayoutBuilder.java b/modules/LayoutAPI/src/main/java/org/gephi/layout/spi/LayoutBuilder.java
@@ -58,7 +58,7 @@ Development and Distribution License("CDDL") (collectively, the
 * the RotateLayout class. The only difference is the angle provided by the
 * LayoutBuilder on the time of instantiation of the RotateLayout object.
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public interface LayoutBuilder {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/AbstractLayout.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/AbstractLayout.java
@@ -51,7 +51,7 @@ Development and Distribution License("CDDL") (collectively, the
 /**
 * Base class for layout algorithms.
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public abstract class AbstractLayout implements Layout {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/ForceLayoutData.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/ForceLayoutData.java
@@ -45,7 +45,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public class ForceLayoutData extends ForceVector {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/AbstractForce.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/AbstractForce.java
@@ -46,7 +46,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public abstract class AbstractForce {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/Displacement.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/Displacement.java
@@ -45,7 +45,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public interface Displacement {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/ForceVector.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/ForceVector.java
@@ -45,7 +45,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public class ForceVector implements LayoutData {

diff --git a/...es/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/ProportionalDisplacement.java b/...es/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/ProportionalDisplacement.java
@@ -47,7 +47,7 @@ Development and Distribution License("CDDL") (collectively, the
 * The movement of the node is in the direction of the force and it's
 * proportional to is module.
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public class ProportionalDisplacement implements Displacement {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/StepDisplacement.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/StepDisplacement.java
@@ -46,7 +46,7 @@ Development and Distribution License("CDDL") (collectively, the
 /**
 * The node is moved a fixed distance (step) in the direction of the force.
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public class StepDisplacement implements Displacement {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/quadtree/BarnesHut.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/quadtree/BarnesHut.java
@@ -49,7 +49,7 @@ Development and Distribution License("CDDL") (collectively, the
 /**
 * Barnes-Hut's O(n log n) force calculation algorithm.
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public class BarnesHut {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/quadtree/QuadTree.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/quadtree/QuadTree.java
@@ -58,7 +58,7 @@ Development and Distribution License("CDDL") (collectively, the
 import org.gephi.graph.spi.LayoutData;

 /**
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public class QuadTree implements Node {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/yifanHu/YifanHu.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/yifanHu/YifanHu.java
@@ -52,7 +52,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 @ServiceProvider(service = LayoutBuilder.class)
 public class YifanHu implements LayoutBuilder {
diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/yifanHu/YifanHuLayout.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/yifanHu/YifanHuLayout.java
@@ -63,7 +63,7 @@ Development and Distribution License("CDDL") (collectively, the
 /**
 * Hu's basic algorithm
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public class YifanHuLayout extends AbstractLayout implements Layout {

@@ -437,7 +437,7 @@ public void setInitialStep(Float initialStep) {
    /**
     * Fa = (n2 - n1) * ||n2 - n1|| / K
     *
-     * @author Helder Suzuki <heldersuzuki@gephi.org>
+     * @author Helder Suzuki
     */
    public class SpringForce extends AbstractForce {

@@ -468,7 +468,7 @@ public Float getOptimalDistance() {
    /**
     * Fr = -C*K*K*(n2-n1)/||n2-n1||
     *
-     * @author Helder Suzuki <heldersuzuki@gephi.org>
+     * @author Helder Suzuki
     */
    public class ElectricalForce extends AbstractForce {

diff --git a/...LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/yifanHu/YifanHuProportional.java b/...LayoutPlugin/src/main/java/org/gephi/layout/plugin/force/yifanHu/YifanHuProportional.java
@@ -52,7 +52,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 @ServiceProvider(service = LayoutBuilder.class)
 public class YifanHuProportional implements LayoutBuilder {
diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/forceAtlas/ForceAtlas.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/forceAtlas/ForceAtlas.java
@@ -51,7 +51,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 @ServiceProvider(service = LayoutBuilder.class)
 public class ForceAtlas implements LayoutBuilder {
diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/random/Random.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/random/Random.java
@@ -51,7 +51,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 @ServiceProvider(service = LayoutBuilder.class)
 public class Random implements LayoutBuilder {
diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/random/RandomLayout.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/random/RandomLayout.java
@@ -55,7 +55,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public class RandomLayout extends AbstractLayout implements Layout {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/rotate/Rotate.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/rotate/Rotate.java
@@ -51,7 +51,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 @ServiceProvider(service = LayoutBuilder.class)
 public class Rotate implements LayoutBuilder {
diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/rotate/RotateLayout.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/rotate/RotateLayout.java
@@ -55,7 +55,7 @@ Development and Distribution License("CDDL") (collectively, the
 /**
 * Sample layout that simply rotates the graph.
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public class RotateLayout extends AbstractLayout implements Layout {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/scale/AbstractScaleLayout.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/scale/AbstractScaleLayout.java
@@ -55,7 +55,7 @@ Development and Distribution License("CDDL") (collectively, the
 /**
 * Sample layout that scales the graph.
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>
+ * @author Helder Suzuki
 */
 public abstract class AbstractScaleLayout extends AbstractLayout implements Layout {

diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/scale/Contract.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/scale/Contract.java
@@ -51,7 +51,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>>
+ * @author Helder Suzuki
 */
 @ServiceProvider(service = LayoutBuilder.class)
 public class Contract implements LayoutBuilder {
diff --git a/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/scale/Expand.java b/modules/LayoutPlugin/src/main/java/org/gephi/layout/plugin/scale/Expand.java
@@ -51,7 +51,7 @@ Development and Distribution License("CDDL") (collectively, the

 /**
 *
- * @author Helder Suzuki <heldersuzuki@gephi.org>>
+ * @author Helder Suzuki
 */
 @ServiceProvider(service = LayoutBuilder.class)
 public class Expand implements LayoutBuilder {