Merge pull request #16 from gravitystorm/documentation
authorRichard Fairhurst <richard@systemeD.net>
Fri, 30 Sep 2011 20:44:16 +0000 (13:44 -0700)
committerRichard Fairhurst <richard@systemeD.net>
Fri, 30 Sep 2011 20:44:16 +0000 (13:44 -0700)
Documentation

build.xml
net/systemeD/controls/DataGridWarningField.as
net/systemeD/controls/FloatingAlert.as
net/systemeD/controls/PromptingTextInputWarning.as

index 8e7b87f..07e43f6 100644 (file)
--- a/build.xml
+++ b/build.xml
@@ -69,7 +69,7 @@
       <arg line="-window-title 'Halcyon and Potlatch2 Developer documentation'" />
       <arg line="-main-title 'Halcyon and Potlatch2 Developer documentation'" />
       <arg line="-footer 'Found an error? Help us fix it. http://wiki.openstreetmap.org/wiki/Potlatch2'"/>
-      <arg line="-package net.systemeD.controls 'Custom-built controls used in Poltatch2'" />
+      <arg line="-package net.systemeD.controls 'Custom-built controls used in Potlatch2'" />
       <arg line="-package net.systemeD.halcyon 'The AS3 rendering library'" />
       <arg line="-package net.systemeD.halcyon.connection 'The connection to the main OSM server, and the entities'" />
       <arg line="-package net.systemeD.halcyon.connection.actions 'The undoable actions that apply to OSM data'" />
@@ -77,6 +77,7 @@
       <arg line="-package net.systemeD.potlatch2 'The OpenStreetMap editor'" />
       <arg line="-package net.systemeD.potlatch2.collections 'Singletons for handling collections loaded from config files'" />
       <arg line="-package net.systemeD.potlatch2.controller 'The various controller states that p2 can be in'" />
+      <arg line="-package net.systemeD.potlatch2.find 'The search dialog for jumping to another place'" />
       <arg line="-package net.systemeD.potlatch2.help 'The Help dialog'" />
       <arg line="-package net.systemeD.potlatch2.mapfeatures 'The engine behind the mapfeatures parsing'" />
       <arg line="-package net.systemeD.potlatch2.mapfeatures.editors 'The various widgets used in the Simple panel'" />
index 47ac699..caa1423 100644 (file)
@@ -3,7 +3,15 @@ package net.systemeD.controls {
        import mx.controls.listClasses.*;
        import flash.display.DisplayObject;
        import mx.controls.Image;
+
+    /**
+    * The DataGridWarningField is a custom Label component that highlights values containing semicolons.
+    * It does so using colour and a warning icon. Simply use in place of a standard Label component, or use
+    * as a custom itemRenderer for a DataGridColumn.
+    *
+    * @see PromptingTextInputWarning
+    */
+
        public class DataGridWarningField extends Label {
 
                private var _image:Image;
index 3fbabce..64c7c2b 100644 (file)
@@ -6,13 +6,24 @@ package net.systemeD.controls {
        import flash.text.*;
        import flash.utils.Timer;
 
+       /**
+       * A FloatingAlert displays a message and stays on screen until the user next presses the mouse or a key.
+       * It's an alternative to showing a modal dialog that would simply be dismissed. The alert appears at the bottom
+       * centre of the screen and fades in as it moves up into view.
+       */
+
        public class FloatingAlert extends Sprite {
 
                private var textfield:TextField;
                private var h:int;
                private var w:int;
                private var timer:Timer;
-               
+
+               /**
+               * Create a new FloatingAlert
+               *
+               * @param message The message to display to the user
+               */
                public function FloatingAlert(message:String) {
                        super();
 
index 3661646..02f4e98 100644 (file)
@@ -3,6 +3,12 @@ package net.systemeD.controls {
        import flash.display.DisplayObject;
        import mx.controls.Image;
 
+    /**
+    * The PromptingTextInputWarning is a custom PromptingTextInput component that highlights values containing semicolons.
+    * It does so using colour and a warning icon. Simply use in place of a flexlib PromptingTextInput component.
+    *
+    * @see DataGridWarningField
+    */
        public class PromptingTextInputWarning extends PromptingTextInput {
 
                private var _image:Image;