Changeset 29384 in osm for applications/editors/josm/plugins/imagery_offset_db/src/iodb/OffsetInfoAction.java

Timestamp:

2013-03-22T22:18:26+01:00 (13 years ago)

Author:

zverik

Message:

ImageryID refactoring and javadocs

File:

• applications/editors/josm/plugins/imagery_offset_db/src/iodb/OffsetInfoAction.java (modified) (3 diffs)

applications/editors/josm/plugins/imagery_offset_db/src/iodb/OffsetInfoAction.java

@@ -10 +10 @@
 
 /**
- * Download a list of imagery offsets for the current position, let user choose which one to use.
+ * Display an information box for an offset.
  * 
- * @author zverik
+ * @author Zverik
+ * @license WTFPL
  */
 public class OffsetInfoAction extends AbstractAction {
-    public static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd");
+    public static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("dd MMMM yyyy");
 
     private Object info;
     
+    /**
+     * Initializes the action with an offset object.
+     * Calls {@link #getInformationObject(iodb.ImageryOffsetBase)}.
+     */
     public OffsetInfoAction( ImageryOffsetBase offset ) {
         super(tr("Offset Information"));
@@ -27 +32 @@
     }
 
+    /**
+     * Shows a dialog with the pre-constructed message.
+     */
     public void actionPerformed(ActionEvent e) {
         JOptionPane.showMessageDialog(Main.parent, info, ImageryOffsetTools.DIALOG_TITLE, JOptionPane.PLAIN_MESSAGE);
     }
 
+    /**
+     * Constructs a string with all information about the given offset.
+     */
     public static Object getInformationObject( ImageryOffsetBase offset ) {
         StringBuilder sb = new StringBuilder();
@@ -61 +72 @@
     }
 
+    /**
+     * Explains a calibration object geometry type: whether is's a point,
+     * a path or a polygon.
+     */
     public static String getGeometryType( CalibrationObject obj ) {
         if( obj.getGeometry() == null )