Changeset 12377 in josm for trunk/src/org

Timestamp:

2017-06-09T21:49:40+02:00 (7 years ago)

Author:

michael2402

Message:

See #14794: Document the layer.gpx package

Location:

trunk/src/org/openstreetmap/josm/gui/layer/gpx

Files:

• CustomizeDrawingAction.java (modified) (2 diffs)
• DateFilterPanel.java (modified) (3 diffs)
• ImportImagesAction.java (modified) (1 diff)
• MarkersFromNamedPointsAction.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/gui/layer/gpx/CustomizeDrawingAction.java

@@ -27 +27 @@
 import org.openstreetmap.josm.tools.ImageProvider;
 
+/**
+ * An action that is displayed in the popup menu for the layer to change the drawing of the GPX layer
+ */
 public class CustomizeDrawingAction extends AbstractAction implements LayerAction, MultiLayerAction {
     private transient List<Layer> layers;
 
+    /**
+     * Create a new {@link CustomizeDrawingAction}
+     * @param l The layers that should be customized
+     */
     public CustomizeDrawingAction(List<Layer> l) {
         this();
@@ -35 +42 @@
     }
 
+    /**
+     * Create a new {@link CustomizeDrawingAction}
+     * @param l The layer that should be customized
+     */
     public CustomizeDrawingAction(Layer l) {
         this();

trunk/src/org/openstreetmap/josm/gui/layer/gpx/DateFilterPanel.java

@@ -21 +21 @@
 import org.openstreetmap.josm.tools.GBC;
 
+/**
+ * A panel that allows the user to input a date range he wants to filter the GPX data for.
+ */
 public class DateFilterPanel extends JPanel {
     private final DateEditorWithSlider dateFrom = new DateEditorWithSlider(tr("From"));
@@ -86 +89 @@
     }
 
+    /**
+     * Applies the filter that was input by the user to the GPX track
+     */
     public void applyFilter() {
         t.stop();
@@ -114 +120 @@
     }
 
+    /**
+     * Sets a listener that should be called after the filter was applied
+     * @param filterAppliedListener The listener to call
+     */
     public void setFilterAppliedListener(ActionListener filterAppliedListener) {
         this.filterAppliedListener = filterAppliedListener;

trunk/src/org/openstreetmap/josm/gui/layer/gpx/ImportImagesAction.java

@@ -24 +24 @@
 import org.openstreetmap.josm.tools.Utils;
 
+/**
+ * An aciton that imports images along a GPX path
+ */
 public class ImportImagesAction extends AbstractAction {
     private final transient GpxLayer layer;
 
+    /**
+     * Create a new {@link ImportImagesAction}
+     * @param layer The layer this action should be for
+     */
     public ImportImagesAction(final GpxLayer layer) {
         super(tr("Import images"), ImageProvider.get("dialogs/geoimage"));

trunk/src/org/openstreetmap/josm/gui/layer/gpx/MarkersFromNamedPointsAction.java

@@ -15 +15 @@
 import org.openstreetmap.josm.tools.ImageProvider;
 
+/**
+ * An action that converts the named points to a new marker layer
+ */
 public class MarkersFromNamedPointsAction extends AbstractAction {
     private final transient GpxLayer layer;
 
+    /**
+     * Construct a new {@link MarkersFromNamedPointsAction}
+     * @param layer The layer this action is for
+     */
     public MarkersFromNamedPointsAction(final GpxLayer layer) {
         super(tr("Markers From Named Points"), ImageProvider.get("addmarkers"));