ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

adding doc comments to text layer - tidying up doc menus

Browse Source 
git-svn-id: http://svn.openlayers.org/trunk/openlayers@5289 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
Tim Schaub
2007-11-27 18:20:18 +00:00
parent f1fe7c7c63
commit 527866aa51
3 changed files with 51 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
apidoc_config/Menu.txt
View File

@@ -50,37 +50,39 @@ Group: OpenLayers {
Group: Control {
File: Control (no auto-title, OpenLayers/Control.js)
File: Control (OpenLayers/Control.js)
File: ArgParser (no auto-title, OpenLayers/Control/ArgParser.js)
File: ZoomToMaxExtent (no auto-title, OpenLayers/Control/ZoomToMaxExtent.js)
File: OverviewMap (no auto-title, OpenLayers/Control/OverviewMap.js)
File: Attribution (no auto-title, OpenLayers/Control/Attribution.js)
File: DragFeature (no auto-title, OpenLayers/Control/DragFeature.js)
File: DragPan (no auto-title, OpenLayers/Control/DragPan.js)
File: DrawFeature (no auto-title, OpenLayers/Control/DrawFeature.js)
File: EditingToolbar (no auto-title, OpenLayers/Control/EditingToolbar.js)
File: KeyboardDefaults (no auto-title, OpenLayers/Control/KeyboardDefaults.js)
File: LayerSwitcher (no auto-title, OpenLayers/Control/LayerSwitcher.js)
File: ModifyFeature (no auto-title, OpenLayers/Control/ModifyFeature.js)
File: MouseDefaults (no auto-title, OpenLayers/Control/MouseDefaults.js)
File: MousePosition (no auto-title, OpenLayers/Control/MousePosition.js)
File: MouseToolbar (no auto-title, OpenLayers/Control/MouseToolbar.js)
File: Navigation (no auto-title, OpenLayers/Control/Navigation.js)
File: NavToolbar (no auto-title, OpenLayers/Control/NavToolbar.js)
File: OverviewMap (no auto-title, OpenLayers/Control/OverviewMap.js)
File: Panel (no auto-title, OpenLayers/Control/Panel.js)
File: PanZoom (no auto-title, OpenLayers/Control/PanZoom.js)
File: PanZoomBar (no auto-title, OpenLayers/Control/PanZoomBar.js)
File: Permalink (no auto-title, OpenLayers/Control/Permalink.js)
File: Scale (no auto-title, OpenLayers/Control/Scale.js)
File: SelectFeature (no auto-title, OpenLayers/Control/SelectFeature.js)
File: ZoomBox (no auto-title, OpenLayers/Control/ZoomBox.js)
File: PanZoom (OpenLayers/Control/PanZoom.js)
File: ZoomToMaxExtent (no auto-title, OpenLayers/Control/ZoomToMaxExtent.js)
} # Group: Control
File: Events (no auto-title, OpenLayers/Events.js)
Group: Feature {
File: Feature (no auto-title, OpenLayers/Feature.js)
File: WFS (no auto-title, OpenLayers/Feature/WFS.js)
File: Feature (OpenLayers/Feature.js)
File: Vector (no auto-title, OpenLayers/Feature/Vector.js)
File: WFS (no auto-title, OpenLayers/Feature/WFS.js)
} # Group: Feature
Group: Format {

10
doc_config/Menu.txt
View File

@@ -52,26 +52,28 @@ Group: OpenLayers {
File: Control (OpenLayers/Control.js)
File: ArgParser (no auto-title, OpenLayers/Control/ArgParser.js)
File: ZoomToMaxExtent (no auto-title, OpenLayers/Control/ZoomToMaxExtent.js)
File: OverviewMap (no auto-title, OpenLayers/Control/OverviewMap.js)
File: Attribution (no auto-title, OpenLayers/Control/Attribution.js)
File: DragFeature (no auto-title, OpenLayers/Control/DragFeature.js)
File: DragPan (no auto-title, OpenLayers/Control/DragPan.js)
File: DrawFeature (no auto-title, OpenLayers/Control/DrawFeature.js)
File: EditingToolbar (no auto-title, OpenLayers/Control/EditingToolbar.js)
File: KeyboardDefaults (no auto-title, OpenLayers/Control/KeyboardDefaults.js)
File: LayerSwitcher (no auto-title, OpenLayers/Control/LayerSwitcher.js)
File: ModifyFeature (no auto-title, OpenLayers/Control/ModifyFeature.js)
File: MouseDefaults (no auto-title, OpenLayers/Control/MouseDefaults.js)
File: MousePosition (no auto-title, OpenLayers/Control/MousePosition.js)
File: MouseToolbar (no auto-title, OpenLayers/Control/MouseToolbar.js)
File: Navigation (no auto-title, OpenLayers/Control/Navigation.js)
File: NavToolbar (no auto-title, OpenLayers/Control/NavToolbar.js)
File: OverviewMap (no auto-title, OpenLayers/Control/OverviewMap.js)
File: Panel (no auto-title, OpenLayers/Control/Panel.js)
File: PanZoom (no auto-title, OpenLayers/Control/PanZoom.js)
File: PanZoomBar (no auto-title, OpenLayers/Control/PanZoomBar.js)
File: Permalink (no auto-title, OpenLayers/Control/Permalink.js)
File: Scale (no auto-title, OpenLayers/Control/Scale.js)
File: SelectFeature (no auto-title, OpenLayers/Control/SelectFeature.js)
File: ZoomBox (no auto-title, OpenLayers/Control/ZoomBox.js)
File: PanZoom (no auto-title, OpenLayers/Control/PanZoom.js)
File: ZoomToMaxExtent (no auto-title, OpenLayers/Control/ZoomToMaxExtent.js)
} # Group: Control
File: Events (no auto-title, OpenLayers/Events.js)
@@ -79,8 +81,8 @@ Group: OpenLayers {
Group: Feature {
File: Feature (OpenLayers/Feature.js)
File: WFS (no auto-title, OpenLayers/Feature/WFS.js)
File: Vector (no auto-title, OpenLayers/Feature/Vector.js)
File: WFS (no auto-title, OpenLayers/Feature/WFS.js)
} # Group: Feature
Group: Format {

52
lib/OpenLayers/Layer/Text.js
View File

@@ -8,17 +8,41 @@
* @requires OpenLayers/Ajax.js
*
* Class: OpenLayers.Layer.Text
* Tab seperated values file parsing code which creates a markers layer.
* This layer creates markers given data in a text file. The <location>
* property of the layer (specified as a property of the options argument
* in the <OpenLayers.Layer.Text> constructor) points to a tab delimited
* file with data used to create markers.
*
* Inherits from;
* The first row of the data file should be a header line with the column names
* of the data. Each column should be delimited by a tab space. The
* possible columns are:
* - *point* lat,lon of the point where a marker is to be placed
* - *lat* Latitude of the point where a marker is to be placed
* - *lon* Longitude of the point where a marker is to be placed
* - *iconURL* URL of marker icon to use.
* - *iconSize* Size of Icon to use.
* - *iconOffset* Where the top-left corner of the icon is to be placed
* relative to the latitude and longitude of the point.
* - *title* The text of the 'title' is placed inside an 'h2' marker
* inside a popup, which opens when the marker is clicked.
* - *description* The text of the 'description' is placed below the h2
* in the popup. this can be plain text or HTML.
*
* Example text file:
* (code)
* lat lon title description iconSize iconOffset icon
* 10 20 title description 21,25 -10,-25 http://www.openlayers.org/dev/img/marker.png
* (end)
*
* Inherits from:
* - <OpenLayers.Layer.Markers>
*/
OpenLayers.Layer.Text = OpenLayers.Class(OpenLayers.Layer.Markers, {
/**
* APIProperty: location
* {String} store url of text file - this should be specified in the
* "options" hashtable. Can not be changed once passed in.
* {String} URL of text file. Must be specified in the "options" argument
* of the constructor. Can not be changed once passed in.
*/
location:null,
@@ -35,14 +59,14 @@ OpenLayers.Layer.Text = OpenLayers.Class(OpenLayers.Layer.Markers, {
selectedFeature: null,
/**
* Constructor: OpenLayers.Layer.Text
* Create a text layer.
*
* Parameters:
* name - {String}
* options - {Object} Hashtable of extra options to tag onto
* the layer. Must include "location" property.
*/
* Constructor: OpenLayers.Layer.Text
* Create a text layer.
*
* Parameters:
* name - {String}
* options - {Object} Object with properties to be set on the layer.
* Must include <location> property.
*/
initialize: function(name, options) {
OpenLayers.Layer.Markers.prototype.initialize.apply(this, arguments);
this.features = new Array();
@@ -58,7 +82,7 @@ OpenLayers.Layer.Text = OpenLayers.Class(OpenLayers.Layer.Markers, {
}
},
/**
/**
* APIMethod: destroy
*/
destroy: function() {
@@ -198,5 +222,3 @@ OpenLayers.Layer.Text = OpenLayers.Class(OpenLayers.Layer.Markers, {
CLASS_NAME: "OpenLayers.Layer.Text"
});