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
@@ -380,6 +380,7 @@ ol.render.canvas.Immediate.prototype.drawRings_ =
|
||||
*
|
||||
* @param {number} zIndex Z index.
|
||||
* @param {function(ol.render.canvas.Immediate)} callback Callback.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.render.canvas.Immediate.prototype.drawAsync = function(zIndex, callback) {
|
||||
@@ -477,7 +478,6 @@ ol.render.canvas.Immediate.prototype.drawFeature = function(feature, style) {
|
||||
* @param {ol.geom.GeometryCollection} geometryCollectionGeometry Geometry
|
||||
* collection.
|
||||
* @param {Object} data Opaque data object.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.canvas.Immediate.prototype.drawGeometryCollectionGeometry =
|
||||
function(geometryCollectionGeometry, data) {
|
||||
|
||||
@@ -17,7 +17,6 @@ ol.render.IVectorContext = function() {
|
||||
/**
|
||||
* @param {number} zIndex Z index.
|
||||
* @param {function(ol.render.canvas.Immediate)} callback Callback.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawAsync = function(zIndex, callback) {
|
||||
};
|
||||
@@ -26,7 +25,6 @@ ol.render.IVectorContext.prototype.drawAsync = function(zIndex, callback) {
|
||||
/**
|
||||
* @param {ol.geom.Circle} circleGeometry Circle geometry.
|
||||
* @param {Object} data Opaque data object,
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawCircleGeometry =
|
||||
function(circleGeometry, data) {
|
||||
@@ -36,7 +34,6 @@ ol.render.IVectorContext.prototype.drawCircleGeometry =
|
||||
/**
|
||||
* @param {ol.Feature} feature Feature.
|
||||
* @param {ol.style.Style} style Style.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawFeature = function(feature, style) {
|
||||
};
|
||||
@@ -46,7 +43,6 @@ ol.render.IVectorContext.prototype.drawFeature = function(feature, style) {
|
||||
* @param {ol.geom.GeometryCollection} geometryCollectionGeometry Geometry
|
||||
* collection.
|
||||
* @param {Object} data Opaque data object.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawGeometryCollectionGeometry =
|
||||
function(geometryCollectionGeometry, data) {
|
||||
@@ -56,7 +52,6 @@ ol.render.IVectorContext.prototype.drawGeometryCollectionGeometry =
|
||||
/**
|
||||
* @param {ol.geom.Point} pointGeometry Point geometry.
|
||||
* @param {Object} data Opaque data object.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawPointGeometry =
|
||||
function(pointGeometry, data) {
|
||||
@@ -66,7 +61,6 @@ ol.render.IVectorContext.prototype.drawPointGeometry =
|
||||
/**
|
||||
* @param {ol.geom.LineString} lineStringGeometry Line string geometry.
|
||||
* @param {Object} data Opaque data object.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawLineStringGeometry =
|
||||
function(lineStringGeometry, data) {
|
||||
@@ -77,7 +71,6 @@ ol.render.IVectorContext.prototype.drawLineStringGeometry =
|
||||
* @param {ol.geom.MultiLineString} multiLineStringGeometry
|
||||
* MultiLineString geometry.
|
||||
* @param {Object} data Opaque data object.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawMultiLineStringGeometry =
|
||||
function(multiLineStringGeometry, data) {
|
||||
@@ -87,7 +80,6 @@ ol.render.IVectorContext.prototype.drawMultiLineStringGeometry =
|
||||
/**
|
||||
* @param {ol.geom.MultiPoint} multiPointGeometry MultiPoint geometry.
|
||||
* @param {Object} data Opaque data object.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawMultiPointGeometry =
|
||||
function(multiPointGeometry, data) {
|
||||
@@ -97,7 +89,6 @@ ol.render.IVectorContext.prototype.drawMultiPointGeometry =
|
||||
/**
|
||||
* @param {ol.geom.MultiPolygon} multiPolygonGeometry MultiPolygon geometry.
|
||||
* @param {Object} data Opaque data object.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawMultiPolygonGeometry =
|
||||
function(multiPolygonGeometry, data) {
|
||||
@@ -107,7 +98,6 @@ ol.render.IVectorContext.prototype.drawMultiPolygonGeometry =
|
||||
/**
|
||||
* @param {ol.geom.Polygon} polygonGeometry Polygon geometry.
|
||||
* @param {Object} data Opaque data object.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawPolygonGeometry =
|
||||
function(polygonGeometry, data) {
|
||||
@@ -121,7 +111,6 @@ ol.render.IVectorContext.prototype.drawPolygonGeometry =
|
||||
* @param {number} stride Stride.
|
||||
* @param {ol.geom.Geometry} geometry Geometry.
|
||||
* @param {Object} data Opaque data object.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.drawText =
|
||||
function(flatCoordinates, offset, end, stride, geometry, data) {
|
||||
@@ -131,7 +120,6 @@ ol.render.IVectorContext.prototype.drawText =
|
||||
/**
|
||||
* @param {ol.style.Fill} fillStyle Fill style.
|
||||
* @param {ol.style.Stroke} strokeStyle Stroke style.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.setFillStrokeStyle =
|
||||
function(fillStyle, strokeStyle) {
|
||||
@@ -140,7 +128,6 @@ ol.render.IVectorContext.prototype.setFillStrokeStyle =
|
||||
|
||||
/**
|
||||
* @param {ol.style.Image} imageStyle Image style.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.setImageStyle = function(imageStyle) {
|
||||
};
|
||||
@@ -148,7 +135,6 @@ ol.render.IVectorContext.prototype.setImageStyle = function(imageStyle) {
|
||||
|
||||
/**
|
||||
* @param {ol.style.Text} textStyle Text style.
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.render.IVectorContext.prototype.setTextStyle = function(textStyle) {
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user