Revision: 6666
http://sourceforge.net/p/jump-pilot/code/6666
Author: michaudm
Date: 2020-12-29 23:50:53 +0000 (Tue, 29 Dec 2020)
Log Message:
-----------
Fix javadoc
Modified Paths:
--------------
core/trunk/src/com/vividsolutions/jump/geom/AbstractGeometryProcessor.java
core/trunk/src/com/vividsolutions/jump/geom/CoordUtil.java
core/trunk/src/com/vividsolutions/jump/geom/EnvelopeUtil.java
core/trunk/src/com/vividsolutions/jump/geom/GeometryFactoryUtil.java
core/trunk/src/com/vividsolutions/jump/geom/LineSegmentUtil.java
core/trunk/src/com/vividsolutions/jump/geom/MicroscopePointAdjuster.java
core/trunk/src/com/vividsolutions/jump/workbench/model/Category.java
core/trunk/src/com/vividsolutions/jump/workbench/model/FeatureEvent.java
core/trunk/src/com/vividsolutions/jump/workbench/model/Layer.java
core/trunk/src/com/vividsolutions/jump/workbench/model/Layerable.java
core/trunk/src/com/vividsolutions/jump/workbench/plugin/AbstractPlugIn.java
core/trunk/src/com/vividsolutions/jump/workbench/plugin/Recordable.java
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/EditAttributeByFormulaDialog.java
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/EditAttributeByFormulaPlugIn.java
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/FormulaEditingPanel.java
Modified:
core/trunk/src/com/vividsolutions/jump/geom/AbstractGeometryProcessor.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/AbstractGeometryProcessor.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/geom/AbstractGeometryProcessor.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -115,6 +115,8 @@
/**
* Method to change each single coordinate of a Geometry - ex. coord
transformation.
+ * @param dd the input Coordinate
+ * @return the transformed Coordinate
*/
public double[] process(double[] dd) {
return dd;
Modified: core/trunk/src/com/vividsolutions/jump/geom/CoordUtil.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/CoordUtil.java 2020-12-29
22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/geom/CoordUtil.java 2020-12-29
23:50:53 UTC (rev 6666)
@@ -92,6 +92,8 @@
/**
* @param coordinates not empty
+ * @param p the point to measure distance to
+ * @return the closest coordinate to p
*/
public static Coordinate closest(Collection coordinates, Coordinate p) {
Assert.isTrue(!coordinates.isEmpty());
Modified: core/trunk/src/com/vividsolutions/jump/geom/EnvelopeUtil.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/EnvelopeUtil.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/geom/EnvelopeUtil.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -44,8 +44,11 @@
private static GeometryFactory factory = new GeometryFactory();
/**
- * Expands an Envelope by a given distance.
+ * Expands an Envelope by a given distance.
* Both positive and negative distances are handled.
+ * @param env the source envelope
+ * @param distance the distance we want to expand the envelop in all
directions
+ * @return the expanded envelope
*/
public static Envelope expand(Envelope env, double distance) {
/**
@@ -80,6 +83,7 @@
* @param originalEnvelope the original envelope
* @param extentFraction the buffer distance expressed as a fraction of the
* average envelope extent
+ * @return the buffered envelope
*/
public static Envelope bufferByFraction(Envelope originalEnvelope,
double extentFraction) {
Modified: core/trunk/src/com/vividsolutions/jump/geom/GeometryFactoryUtil.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/GeometryFactoryUtil.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/geom/GeometryFactoryUtil.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -51,8 +51,9 @@
* input list which have the requested dimension.
* The result is thus guaranteed to have the dimension requested.
*
- * @param geom
- * @param dimension
+ * @param geom input Geometry
+ * @param dimension requested dimension
+ * @return geometry made of the elements having the requested dimension
*/
public static Geometry buildGeometry(Geometry geom, int dimension) {
GeometryFactory factory = new GeometryFactory(geom.getPrecisionModel(),
Modified: core/trunk/src/com/vividsolutions/jump/geom/LineSegmentUtil.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/LineSegmentUtil.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/geom/LineSegmentUtil.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -97,8 +97,8 @@
* the distance from one segment's endpoints to the other segment
* and choose the maximum.
*
- * @param seg0
- * @param seg1
+ * @param seg0 first line segment
+ * @param seg1 second line segment
* @return the Hausdorff distance between the segments
*/
public static double hausdorffDistance(LineSegment seg0, LineSegment seg1)
{
Modified:
core/trunk/src/com/vividsolutions/jump/geom/MicroscopePointAdjuster.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/MicroscopePointAdjuster.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/geom/MicroscopePointAdjuster.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -83,6 +83,7 @@
/**
* Return a list of adjusted Segments.
* Probably for testing only.
+ * @return a list of adjusted segments
*/
public List adjustSegments() {
// find all points in Envelope
Modified: core/trunk/src/com/vividsolutions/jump/workbench/model/Category.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/model/Category.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/workbench/model/Category.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -108,6 +108,7 @@
}
/**
+ * @param layerable the layerable whose index we want to know
* @return -1 if the category does not contain the layerable
*/
public int indexOf(Layerable layerable) {
@@ -120,6 +121,7 @@
/**
* @param index 0 to add to the top
+ * @param layerable the layerable to add
*/
public void add(int index, Layerable layerable) {
layerables.add(index, layerable);
@@ -131,6 +133,7 @@
/**
* Called by Java2XML
+ * @param layerable the Layerable to add
*/
public void addPersistentLayerable(Layerable layerable) {
add(layerables.size(), layerable);
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/model/FeatureEvent.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/model/FeatureEvent.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/workbench/model/FeatureEvent.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -53,6 +53,9 @@
private Collection<Feature> oldFeatureAttClones;
/**
+ * @param features a collection of features
+ * @param type the type of event (one of ADDED, DELETED,
GEOMETRY_MODIFIED, ATTRIBUTES_MODIFIED)
+ * @param layer the target layer
* @param oldFeatureClones for GEOMETRY_MODIFIED events, clones of the
Features before
* they were modified; null for other events
*/
Modified: core/trunk/src/com/vividsolutions/jump/workbench/model/Layer.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/model/Layer.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/workbench/model/Layer.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -128,6 +128,7 @@
}
/**
+ * @param fillColor the fillColor we want to derive a lineColor
* @return a darker version of the given fill colour, for use as the line
* colour
*/
@@ -249,6 +250,7 @@
* using FeatureCollectionWrapper#getWrappee. However, parties are encouraged
* to use the FeatureCollectionWrapper instead, so that feature additions and
* removals cause FeatureEvents to be fired (by the Layer).
+ * @return the FeatureCollectionWrapper containing features
*/
public FeatureCollectionWrapper getFeatureCollectionWrapper() {
return featureCollectionWrapper;
@@ -284,6 +286,8 @@
/**
* get a list of all enabled styles matching the parameter class
+ * @param filter superclass of the requested styles
+ * @return a list containing enabled styles implementing the requested class
*/
public List<Style> getStylesIfEnabled(Class filter) {
List<Style> enabledStyles = new ArrayList<>();
@@ -297,6 +301,7 @@
/**
* get a list of all styles
+ * @return all Styles of this Layer in a new unmodifiable List
*/
public List<Style> getStyles() {
return Collections.unmodifiableList(styles);
@@ -304,6 +309,8 @@
/**
* get a list of all styles matching the parameter class
+ * @param filter superclass of the requested styles
+ * @return a list containing all styles implementing the requested class
*/
public List<Style> getStyles(Class filter) {
List<Style> someStyles = new ArrayList<>();
@@ -456,6 +463,10 @@
/**
* Enables a layer to be changed undoably. Since the layer's features are
* saved, only use this method for layers with few features.
+ * @param layerName the target Layer name
+ * @param proxy a LayerManager proxy
+ * @param wrappeeCommand the undoable command
+ * @return the command to be executed
*/
public static UndoableCommand addUndo(final String layerName,
final LayerManagerProxy proxy,
@@ -509,6 +520,7 @@
/**
* Does nothing if the underlying feature collection is not a FeatureDataset.
+ * @param layer the Layer whose envelope must be invalidated
*/
public static void tryToInvalidateEnvelope(Layer layer) {
if (layer.getFeatureCollectionWrapper().getUltimateWrappee() instanceof
FeatureDataset) {
Modified: core/trunk/src/com/vividsolutions/jump/workbench/model/Layerable.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/model/Layerable.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/workbench/model/Layerable.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -63,6 +63,7 @@
/**
* Called by Java2XML
+ * @param layerManager the LayerManager
*/
void setLayerManager(LayerManager layerManager);
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/plugin/AbstractPlugIn.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/plugin/AbstractPlugIn.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/workbench/plugin/AbstractPlugIn.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -132,6 +132,12 @@
public void initialize(PlugInContext context) throws Exception {
}
+ /**
+ * Execute the PlugIn.
+ * @param context context of this PlugIn
+ * @return true if the PlugIn has been executed
+ * @throws Exception if an Exception occurs during execution
+ */
public boolean execute(PlugInContext context) throws Exception {
return true;
}
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/plugin/Recordable.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/plugin/Recordable.java
2020-12-29 22:32:42 UTC (rev 6665)
+++ core/trunk/src/com/vividsolutions/jump/workbench/plugin/Recordable.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -12,6 +12,6 @@
* Set parameters with which to execute a plugin.
* @param map a map of parameters
*/
- public void setParameters(Map<String,Object> map);
+ void setParameters(Map<String,Object> map);
}
Modified:
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/EditAttributeByFormulaDialog.java
===================================================================
---
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/EditAttributeByFormulaDialog.java
2020-12-29 22:32:42 UTC (rev 6665)
+++
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/EditAttributeByFormulaDialog.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -12,11 +12,7 @@
package de.fho.jump.pirol.plugins.EditAttributeByFormula;
import java.awt.Frame;
-import java.awt.BorderLayout;
-//import java.awt.GridBagConstraints;
-//import java.awt.GridBagLayout;
import java.awt.HeadlessException;
-import java.awt.Insets;
import javax.swing.JDialog;
import javax.swing.JPanel;
@@ -54,21 +50,25 @@
protected OkCancelButtonPanel okCancelPanel = null;
protected FormulaEditingPanel formPanel = null;
- protected OKCancelListener okCancelListener = null;
+ protected OKCancelListener okCancelListener;
- protected String text = null;
+ protected String text;
- protected FeatureSchema featureSchema = null;
+ protected FeatureSchema featureSchema;
protected PropertiesHandler storedFormulas = null;
/**
- * @param parentFrame
- * @param title
- * @param modal
- * @throws java.awt.HeadlessException
+ * @param parentFrame the parent frame
+ * @param title title of the dialog box
+ * @param modal true if the dialog must be modal
+ * @param text explanation text to display on top of the dialog
+ * @param featureSchema feature schema of the layer
+ * @param storedFormulas PropertiesHandler containing formulas
+ * @throws java.awt.HeadlessException if the environment does not support
keyboard, display or mouse
*/
- public EditAttributeByFormulaDialog(Frame parentFrame, String title,
boolean modal, String text, FeatureSchema featureSchema, PropertiesHandler
storedFormulas )
+ public EditAttributeByFormulaDialog(Frame parentFrame, String title,
boolean modal, String text,
+ FeatureSchema featureSchema,
PropertiesHandler storedFormulas )
throws HeadlessException {
super(parentFrame, title, modal);
@@ -80,9 +80,18 @@
this.setupUI();
}
-
+
+ /**
+ * @param parentFrame the parent frame
+ * @param title title of the dialog box
+ * @param modal true if the dialog must be modal
+ * @param text explanation text to display on top of the dialog
+ * @param featureSchema feature schema of the layer
+ * @throws java.awt.HeadlessException if the environment does not support
keyboard, display or mouse
+ */
//[sstein 24.March 2007] new - since we dont have stored formulas
- public EditAttributeByFormulaDialog(Frame parentFrame, String title,
boolean modal, String text, FeatureSchema featureSchema)
+ public EditAttributeByFormulaDialog(Frame parentFrame, String title,
boolean modal,
+ String text, FeatureSchema
featureSchema)
throws HeadlessException {
super(parentFrame, title, modal);
Modified:
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/EditAttributeByFormulaPlugIn.java
===================================================================
---
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/EditAttributeByFormulaPlugIn.java
2020-12-29 22:32:42 UTC (rev 6665)
+++
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/EditAttributeByFormulaPlugIn.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -144,16 +144,11 @@
.add(checkFactory.createAtLeastNLayersMustBeSelectedCheck(1))
.add(checkFactory.createSelectedLayersMustBeEditableCheck());
}
+
- /* //-- [sstein 24.March 2007] disabled since we make it to a
- // normal plugin, not a StandardPirolPlugin
- public EditAttributeByFormulaPlugIn(){
- super(new PersonalLogger(DebugUserIds.ALL));
- }
- */
-
/**
- * @inheritDoc
+ * Return Icon as String
+ * @return null
*/
public String getIconString() {
return null;
@@ -160,7 +155,8 @@
}
/**
- *@inheritDoc
+ * Return the name of the menu where this plugin can be found
+ * @return the name of the menu where this plugin can be found
*/
public String getCategoryName() {
return PirolPlugInSettings.getName_AttributeMenu();
@@ -167,7 +163,7 @@
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
public boolean execute(PlugInContext context) throws Exception {
Layer layer = StandardPirolPlugIn.getSelectedLayer(context);
Modified:
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/FormulaEditingPanel.java
===================================================================
---
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/FormulaEditingPanel.java
2020-12-29 22:32:42 UTC (rev 6665)
+++
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/FormulaEditingPanel.java
2020-12-29 23:50:53 UTC (rev 6666)
@@ -219,7 +219,7 @@
/**
* ... to react on a selection in the stored formula drop down menu ...
- *@param event
+ * @param event the event to process
*/
public void actionPerformed(ActionEvent event) {
if (this.storedFormulas != null){
@@ -230,7 +230,8 @@
}
/**
- *@inheritDoc
+ * Check the formula and return false if it could not be parsed
+ * @return false if the formula could not be parsed
*/
public boolean areValuesOk() {
try {
_______________________________________________
Jump-pilot-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
