Documentation and exports

This commit is contained in:
Tim Schaub
2014-02-13 10:37:10 -07:00
parent 66d5d1d277
commit 0ec5201f3a
5 changed files with 19 additions and 6 deletions

View File

@@ -1,7 +1,8 @@
@exportSymbol ol.Feature
@exportProperty ol.Feature.prototype.getGeometryName
@exportProperty ol.Feature.prototype.setGeometryName
@exportProperty ol.Feature.prototype.getId
@exportProperty ol.Feature.prototype.setId
@exportProperty ol.Feature.prototype.getStyle
@exportProperty ol.Feature.prototype.getStyleFunction
@exportProperty ol.Feature.prototype.setGeometryName
@exportProperty ol.Feature.prototype.setId
@exportProperty ol.Feature.prototype.setStyle

View File

@@ -1,6 +1,8 @@
@exportSymbol ol.FeatureOverlay
@exportProperty ol.FeatureOverlay.prototype.addFeature
@exportProperty ol.FeatureOverlay.prototype.getFeatures
@exportProperty ol.FeatureOverlay.prototype.getStyle
@exportProperty ol.FeatureOverlay.prototype.getStyleFunction
@exportProperty ol.FeatureOverlay.prototype.setFeatures
@exportProperty ol.FeatureOverlay.prototype.setMap
@exportProperty ol.FeatureOverlay.prototype.setStyle

View File

@@ -241,6 +241,9 @@ ol.FeatureOverlay.prototype.setMap = function(map) {
/**
* Set the style for features. This can be a single style object, an array
* of styles, or a function that takes a feature and resolution and returns
* an array of styles.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Overlay style.
* @todo stability experimental
@@ -253,6 +256,8 @@ ol.FeatureOverlay.prototype.setStyle = function(style) {
/**
* Get the style for features. This returns whatever was passed to the `style`
* option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Overlay style.
*/
@@ -262,6 +267,7 @@ ol.FeatureOverlay.prototype.getStyle = function() {
/**
* Get the style function.
* @return {ol.feature.StyleFunction|undefined} Style function.
*/
ol.FeatureOverlay.prototype.getStyleFunction = function() {

View File

@@ -1,2 +1,4 @@
@exportSymbol ol.layer.Vector
@exportProperty ol.layer.Vector.prototype.getStyle
@exportProperty ol.layer.Vector.prototype.getStyleFunction
@exportProperty ol.layer.Vector.prototype.setStyle

View File

@@ -68,9 +68,10 @@ goog.exportProperty(
/**
* Get the style for features. This returns whatever was passed to the `style`
* option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Layer style.
* @todo stability experimental
*/
ol.layer.Vector.prototype.getStyle = function() {
return this.style_;
@@ -78,6 +79,7 @@ ol.layer.Vector.prototype.getStyle = function() {
/**
* Get the style function.
* @return {ol.feature.StyleFunction} Layer style function.
* @todo stability experimental
*/
@@ -103,9 +105,9 @@ goog.exportProperty(
/**
* If the styles are changed by setting a new style function or by changing the
* value returned by the style function then `dispatchChangeEvent` should be
* called on the layer for the layer to be refreshed on the screen.
* Set the style for features. This can be a single style object, an array
* of styles, or a function that takes a feature and resolution and returns
* an array of styles.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Layer style.
* @todo stability experimental