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

Get rid of stability annotations and document stability with api

Browse Source 
This change adds a stability value to the api annotation, with
'experimental' as default value.

enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.

Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
This commit is contained in:
Andreas Hocevar
2014-04-17 00:56:44 +02:00
committed by Tim Schaub
parent 29b643c7b0
commit fbdbbfb7a7
146 changed files with 506 additions and 764 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/style/circlestyle.js
-4
View File
@@ -17,7 +17,6 @@ goog.require('ol.style.Stroke');
* @constructor
* @param {olx.style.CircleOptions=} opt_options Options.
* @extends {ol.style.Image}
* @todo stability experimental
* @todo api
*/
ol.style.Circle = function(opt_options) {
@@ -92,7 +91,6 @@ ol.style.Circle.prototype.getAnchor = function() {
/**
* @return {ol.style.Fill} Fill style.
* @todo stability experimental
* @todo api
*/
ol.style.Circle.prototype.getFill = function() {
@@ -127,7 +125,6 @@ ol.style.Circle.prototype.getImageState = function() {
/**
* @return {number} Radius.
* @todo stability experimental
* @todo api
*/
ol.style.Circle.prototype.getRadius = function() {
@@ -146,7 +143,6 @@ ol.style.Circle.prototype.getSize = function() {
/**
* @return {ol.style.Stroke} Stroke style.
* @todo stability experimental
* @todo api
*/
ol.style.Circle.prototype.getStroke = function() {
src/ol/style/fillstyle.js
-2
View File
@@ -7,7 +7,6 @@ goog.require('ol.color');
/**
* @constructor
* @param {olx.style.FillOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.style.Fill = function(opt_options) {
@@ -24,7 +23,6 @@ ol.style.Fill = function(opt_options) {
/**
* @return {ol.Color|string} Color.
* @todo stability experimental
* @todo api
*/
ol.style.Fill.prototype.getColor = function() {
src/ol/style/iconstyle.js
-2
View File
@@ -40,7 +40,6 @@ ol.style.IconAnchorUnits = {
* @constructor
* @param {olx.style.IconOptions=} opt_options Options.
* @extends {ol.style.Image}
* @todo stability experimental
* @todo api
*/
ol.style.Icon = function(opt_options) {
@@ -193,7 +192,6 @@ ol.style.Icon.prototype.getHitDetectionImage = function(pixelRatio) {
/**
* @return {string|undefined} Image src.
* @todo stability experimental
* @todo api
*/
ol.style.Icon.prototype.getSrc = function() {
src/ol/style/imagestyle.js
-6
View File
@@ -29,7 +29,6 @@ ol.style.ImageOptions;
/**
* @constructor
* @param {ol.style.ImageOptions} options Options.
* @todo stability experimental
* @todo api
*/
ol.style.Image = function(options) {
@@ -85,7 +84,6 @@ ol.style.Image.prototype.getRotateWithView = function() {
/**
* @return {number} Rotation.
* @todo stability experimental
* @todo api
*/
ol.style.Image.prototype.getRotation = function() {
@@ -95,7 +93,6 @@ ol.style.Image.prototype.getRotation = function() {
/**
* @return {number} Scale.
* @todo stability experimental
* @todo api
*/
ol.style.Image.prototype.getScale = function() {
@@ -114,7 +111,6 @@ ol.style.Image.prototype.getSnapToPixel = function() {
/**
* @function
* @return {Array.<number>} Anchor.
* @todo stability experimental
*/
ol.style.Image.prototype.getAnchor = goog.abstractMethod;
@@ -123,7 +119,6 @@ ol.style.Image.prototype.getAnchor = goog.abstractMethod;
* @function
* @param {number} pixelRatio Pixel ratio.
* @return {HTMLCanvasElement|HTMLVideoElement|Image} Image element.
* @todo stability experimental
*/
ol.style.Image.prototype.getImage = goog.abstractMethod;
@@ -144,7 +139,6 @@ ol.style.Image.prototype.getHitDetectionImage = goog.abstractMethod;
/**
* @function
* @return {ol.Size} Size.
* @todo stability experimental
*/
ol.style.Image.prototype.getSize = goog.abstractMethod;
src/ol/style/strokestyle.js
-7
View File
@@ -7,7 +7,6 @@ goog.require('ol.color');
/**
* @constructor
* @param {olx.style.StrokeOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.style.Stroke = function(opt_options) {
@@ -54,7 +53,6 @@ ol.style.Stroke = function(opt_options) {
/**
* @return {ol.Color|string} Color.
* @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getColor = function() {
@@ -64,7 +62,6 @@ ol.style.Stroke.prototype.getColor = function() {
/**
* @return {string|undefined} Line cap.
* @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getLineCap = function() {
@@ -74,7 +71,6 @@ ol.style.Stroke.prototype.getLineCap = function() {
/**
* @return {Array.<number>} Line dash.
* @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getLineDash = function() {
@@ -84,7 +80,6 @@ ol.style.Stroke.prototype.getLineDash = function() {
/**
* @return {string|undefined} Line join.
* @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getLineJoin = function() {
@@ -94,7 +89,6 @@ ol.style.Stroke.prototype.getLineJoin = function() {
/**
* @return {number|undefined} Miter limit.
* @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getMiterLimit = function() {
@@ -104,7 +98,6 @@ ol.style.Stroke.prototype.getMiterLimit = function() {
/**
* @return {number|undefined} Width.
* @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getWidth = function() {
src/ol/style/style.js
-6
View File
@@ -8,7 +8,6 @@ goog.require('ol.style.Image');
/**
* @constructor
* @param {olx.style.StyleOptions=} opt_options Style options.
* @todo stability experimental
* @todo api
*/
ol.style.Style = function(opt_options) {
@@ -50,7 +49,6 @@ ol.style.Style = function(opt_options) {
/**
* @return {ol.style.Fill} Fill style.
* @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getFill = function() {
@@ -60,7 +58,6 @@ ol.style.Style.prototype.getFill = function() {
/**
* @return {ol.style.Image} Image style.
* @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getImage = function() {
@@ -70,7 +67,6 @@ ol.style.Style.prototype.getImage = function() {
/**
* @return {ol.style.Stroke} Stroke style.
* @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getStroke = function() {
@@ -80,7 +76,6 @@ ol.style.Style.prototype.getStroke = function() {
/**
* @return {ol.style.Text} Text style.
* @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getText = function() {
@@ -90,7 +85,6 @@ ol.style.Style.prototype.getText = function() {
/**
* @return {number|undefined} ZIndex.
* @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getZIndex = function() {
src/ol/style/textstyle.js
-9
View File
@@ -5,7 +5,6 @@ goog.provide('ol.style.Text');
/**
* @constructor
* @param {olx.style.TextOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.style.Text = function(opt_options) {
@@ -76,7 +75,6 @@ ol.style.Text = function(opt_options) {
/**
* @return {string|undefined} Font.
* @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getFont = function() {
@@ -102,7 +100,6 @@ ol.style.Text.prototype.getOffsetY = function() {
/**
* @return {ol.style.Fill} Fill style.
* @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getFill = function() {
@@ -112,7 +109,6 @@ ol.style.Text.prototype.getFill = function() {
/**
* @return {number|undefined} Rotation.
* @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getRotation = function() {
@@ -122,7 +118,6 @@ ol.style.Text.prototype.getRotation = function() {
/**
* @return {number|undefined} Scale.
* @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getScale = function() {
@@ -132,7 +127,6 @@ ol.style.Text.prototype.getScale = function() {
/**
* @return {ol.style.Stroke} Stroke style.
* @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getStroke = function() {
@@ -142,7 +136,6 @@ ol.style.Text.prototype.getStroke = function() {
/**
* @return {string|undefined} Text.
* @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getText = function() {
@@ -152,7 +145,6 @@ ol.style.Text.prototype.getText = function() {
/**
* @return {string|undefined} Text align.
* @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getTextAlign = function() {
@@ -162,7 +154,6 @@ ol.style.Text.prototype.getTextAlign = function() {
/**
* @return {string|undefined} Text baseline.
* @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getTextBaseline = function() {