Greatly simplify and document the usage of JSDoc
This commit simplifies the exports.js plugin so it only relies on the stability notes to generate the documentation, which completely decouples it from the exportable API. As a rule of thumb, whenever something has an 'api' annotation, it should also have a 'stability' annotation. A more verbose documentation of ol3 specific annotation usage is available in the new 'apidoc/readme.md' file. This commit also modifies all source files to implement these usage suggestions.
This commit is contained in:
committed by
Tim Schaub
parent
aaf6101d0f
commit
c17ac0cae3
@@ -92,6 +92,7 @@ ol.style.Circle.prototype.getAnchor = function() {
|
||||
|
||||
/**
|
||||
* @return {ol.style.Fill} Fill style.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Circle.prototype.getFill = function() {
|
||||
@@ -126,6 +127,7 @@ ol.style.Circle.prototype.getImageState = function() {
|
||||
|
||||
/**
|
||||
* @return {number} Radius.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Circle.prototype.getRadius = function() {
|
||||
@@ -144,6 +146,7 @@ ol.style.Circle.prototype.getSize = function() {
|
||||
|
||||
/**
|
||||
* @return {ol.style.Stroke} Stroke style.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Circle.prototype.getStroke = function() {
|
||||
|
||||
@@ -7,6 +7,7 @@ goog.require('ol.color');
|
||||
/**
|
||||
* @constructor
|
||||
* @param {olx.style.FillOptions=} opt_options Options.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Fill = function(opt_options) {
|
||||
@@ -23,6 +24,7 @@ ol.style.Fill = function(opt_options) {
|
||||
|
||||
/**
|
||||
* @return {ol.Color|string} Color.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Fill.prototype.getColor = function() {
|
||||
|
||||
@@ -40,6 +40,7 @@ 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) {
|
||||
@@ -192,6 +193,7 @@ ol.style.Icon.prototype.getHitDetectionImage = function(pixelRatio) {
|
||||
|
||||
/**
|
||||
* @return {string|undefined} Image src.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Icon.prototype.getSrc = function() {
|
||||
|
||||
@@ -29,6 +29,7 @@ ol.style.ImageOptions;
|
||||
/**
|
||||
* @constructor
|
||||
* @param {ol.style.ImageOptions} options Options.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Image = function(options) {
|
||||
@@ -84,6 +85,7 @@ ol.style.Image.prototype.getRotateWithView = function() {
|
||||
|
||||
/**
|
||||
* @return {number} Rotation.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Image.prototype.getRotation = function() {
|
||||
@@ -93,6 +95,7 @@ ol.style.Image.prototype.getRotation = function() {
|
||||
|
||||
/**
|
||||
* @return {number} Scale.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Image.prototype.getScale = function() {
|
||||
@@ -109,14 +112,18 @@ ol.style.Image.prototype.getSnapToPixel = function() {
|
||||
|
||||
|
||||
/**
|
||||
* @function
|
||||
* @return {Array.<number>} Anchor.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
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;
|
||||
|
||||
@@ -135,7 +142,9 @@ ol.style.Image.prototype.getHitDetectionImage = goog.abstractMethod;
|
||||
|
||||
|
||||
/**
|
||||
* @function
|
||||
* @return {ol.Size} Size.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.style.Image.prototype.getSize = goog.abstractMethod;
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@ goog.require('ol.color');
|
||||
/**
|
||||
* @constructor
|
||||
* @param {olx.style.StrokeOptions=} opt_options Options.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Stroke = function(opt_options) {
|
||||
@@ -53,6 +54,7 @@ ol.style.Stroke = function(opt_options) {
|
||||
|
||||
/**
|
||||
* @return {ol.Color|string} Color.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Stroke.prototype.getColor = function() {
|
||||
@@ -62,6 +64,7 @@ ol.style.Stroke.prototype.getColor = function() {
|
||||
|
||||
/**
|
||||
* @return {string|undefined} Line cap.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Stroke.prototype.getLineCap = function() {
|
||||
@@ -71,6 +74,7 @@ ol.style.Stroke.prototype.getLineCap = function() {
|
||||
|
||||
/**
|
||||
* @return {Array.<number>} Line dash.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Stroke.prototype.getLineDash = function() {
|
||||
@@ -80,6 +84,7 @@ ol.style.Stroke.prototype.getLineDash = function() {
|
||||
|
||||
/**
|
||||
* @return {string|undefined} Line join.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Stroke.prototype.getLineJoin = function() {
|
||||
@@ -89,6 +94,7 @@ ol.style.Stroke.prototype.getLineJoin = function() {
|
||||
|
||||
/**
|
||||
* @return {number|undefined} Miter limit.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Stroke.prototype.getMiterLimit = function() {
|
||||
@@ -98,6 +104,7 @@ ol.style.Stroke.prototype.getMiterLimit = function() {
|
||||
|
||||
/**
|
||||
* @return {number|undefined} Width.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Stroke.prototype.getWidth = function() {
|
||||
|
||||
@@ -50,6 +50,7 @@ ol.style.Style = function(opt_options) {
|
||||
|
||||
/**
|
||||
* @return {ol.style.Fill} Fill style.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Style.prototype.getFill = function() {
|
||||
@@ -59,6 +60,7 @@ ol.style.Style.prototype.getFill = function() {
|
||||
|
||||
/**
|
||||
* @return {ol.style.Image} Image style.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Style.prototype.getImage = function() {
|
||||
@@ -68,6 +70,7 @@ ol.style.Style.prototype.getImage = function() {
|
||||
|
||||
/**
|
||||
* @return {ol.style.Stroke} Stroke style.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Style.prototype.getStroke = function() {
|
||||
@@ -77,6 +80,7 @@ ol.style.Style.prototype.getStroke = function() {
|
||||
|
||||
/**
|
||||
* @return {ol.style.Text} Text style.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Style.prototype.getText = function() {
|
||||
@@ -86,6 +90,7 @@ ol.style.Style.prototype.getText = function() {
|
||||
|
||||
/**
|
||||
* @return {number|undefined} ZIndex.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Style.prototype.getZIndex = function() {
|
||||
|
||||
@@ -5,6 +5,7 @@ goog.provide('ol.style.Text');
|
||||
/**
|
||||
* @constructor
|
||||
* @param {olx.style.TextOptions=} opt_options Options.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Text = function(opt_options) {
|
||||
@@ -75,6 +76,7 @@ ol.style.Text = function(opt_options) {
|
||||
|
||||
/**
|
||||
* @return {string|undefined} Font.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Text.prototype.getFont = function() {
|
||||
@@ -100,6 +102,7 @@ ol.style.Text.prototype.getOffsetY = function() {
|
||||
|
||||
/**
|
||||
* @return {ol.style.Fill} Fill style.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Text.prototype.getFill = function() {
|
||||
@@ -109,6 +112,7 @@ ol.style.Text.prototype.getFill = function() {
|
||||
|
||||
/**
|
||||
* @return {number|undefined} Rotation.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Text.prototype.getRotation = function() {
|
||||
@@ -118,6 +122,7 @@ ol.style.Text.prototype.getRotation = function() {
|
||||
|
||||
/**
|
||||
* @return {number|undefined} Scale.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Text.prototype.getScale = function() {
|
||||
@@ -127,6 +132,7 @@ ol.style.Text.prototype.getScale = function() {
|
||||
|
||||
/**
|
||||
* @return {ol.style.Stroke} Stroke style.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Text.prototype.getStroke = function() {
|
||||
@@ -136,6 +142,7 @@ ol.style.Text.prototype.getStroke = function() {
|
||||
|
||||
/**
|
||||
* @return {string|undefined} Text.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Text.prototype.getText = function() {
|
||||
@@ -145,6 +152,7 @@ ol.style.Text.prototype.getText = function() {
|
||||
|
||||
/**
|
||||
* @return {string|undefined} Text align.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Text.prototype.getTextAlign = function() {
|
||||
@@ -154,6 +162,7 @@ ol.style.Text.prototype.getTextAlign = function() {
|
||||
|
||||
/**
|
||||
* @return {string|undefined} Text baseline.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.style.Text.prototype.getTextBaseline = function() {
|
||||
|
||||
Reference in New Issue
Block a user