Commit Graph

45 Commits

Author SHA1 Message Date
Tim Schaub
1f88015db0 Add ol.proj.transformExtent function 2014-07-06 13:22:47 -06:00
Tim Schaub
4cf5ab4620 Use @api annotation instead of @todo api 2014-07-05 15:41:14 -04:00
Peter Robins
ff3e66d550 Improve docs for projection/transform functions 2014-06-23 06:16:35 -04:00
Peter Robins
0a2b3b0bca Stop exporting getTransformFromProjections and transformWithProjections 2014-06-18 08:19:56 +01:00
Peter Robins
41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04:00
Tim Schaub
e4e3b2229a Defines in ol namespace defined in ol.js 2014-04-30 08:54:30 -06:00
Tim Schaub
d552dfd96d Making ol.proj.Projection subclasses exportable
Because ol.proj.EPSG4326 et al. extend ol.proj.Projection which has exportable methods, these constructors need to be exportable as well (e.g. so ol.proj.EPSG4326.prototype is defined in exports.js when calling goog.exportProperty on getCode etc.).  If we really don't want these to be exportable, they should be removed or made private (and named like ol.proj.EPSG4326_) for internal use only.
2014-04-29 09:57:25 -06:00
Andreas Hocevar
fbdbbfb7a7 Get rid of stability annotations and document stability with api
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.
2014-04-29 09:53:07 -06:00
Andreas Hocevar
c17ac0cae3 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.
2014-04-29 09:53:06 -06:00
Tim Schaub
fb497f5288 Annotations for exports 2014-04-29 09:53:05 -06:00
Bart van den Eijnden
962ddff1c2 Implement readProjection on ol.format.WFS and add WFS JSONP example 2014-04-24 20:58:32 +02:00
Frederic Junod
08d6e060fa Fix coding style 2014-03-05 10:33:07 +01:00
Tom Payne
dade8e4e1a Don't export ol.proj.Units 2014-02-06 22:44:17 +01:00
Tom Payne
b901fba742 Allow ol.proj.Projection units option to be a string 2014-02-06 22:42:36 +01:00
Bart van den Eijnden
1ada9dfea5 Add export for ol.proj.METERS_PER_UNIT 2014-01-30 11:12:17 +01:00
Frederic Junod
9f79d33486 Create 'type' annotation for 'const' variables
From https://developers.google.com/closure/compiler/docs/js-for-compiler:
  "The type declaration and additional comment are optional. If you
  provide a type declaration, put the declaration on a separate line."
2014-01-09 09:53:20 +01:00
Tom Payne
da396039ce Move proj.exports and proj.jsdoc into proj directory 2014-01-03 14:55:02 +01:00
Olivier Terral
fe1f98899f Add Zoomify stuff 2013-12-16 16:00:59 +01:00
Tom Payne
fbc23499e4 Add @struct annotation for simple classes 2013-12-13 18:59:26 +01:00
Éric Lemoine
315c42f0a7 Use olx namespace for options types in source code
sed command used: find src/ol -name '*.js' -exec sed -ri 's/\{ol(\.(\w|\.)+Options\=?\})/{olx\1/' \{\} \;
2013-12-12 15:02:03 +01:00
Frederic Junod
3efc810ca9 Quote values in apidoc 2013-10-29 11:01:49 +01:00
Paul Spencer
bada596b45 Add default stability level to docs of exported things. 2013-10-24 18:20:24 -04:00
Frederic Junod
ef929e9a72 Fix jsdoc formating 2013-09-24 12:18:00 +02:00
Tim Schaub
b524de417b Rename ol.ProjectionUnits to ol.proj.Units 2013-09-15 22:04:51 -06:00
Tim Schaub
9a29c0e22d Rename ol.ProjectionLike to ol.proj.ProjectionLike 2013-09-15 22:01:56 -06:00
Tim Schaub
3b20cc7b53 Rename ol.Projection to ol.proj.Projection 2013-09-15 22:01:56 -06:00
Tim Schaub
e806f51b3d Changing extent structure back to single array: [minX, minY, maxX, maxY]
This means we'll have to have a new structure and new methods for 3D envelopes.
2013-09-15 00:31:32 -06:00
Tim Schaub
0eb4cd6dd4 Proj support for new extent structure 2013-09-14 21:11:53 -06:00
Tim Schaub
fa1601f04f Export namespaces or constructors but not functions 2013-09-04 13:55:54 -06:00
Éric Lemoine
561581cf8b Move exports file for proj 2013-08-29 15:38:00 +02:00
ahocevar
023d3faf3c Do not translate projections using regular expressions 2013-08-04 15:10:09 +02:00
Tim Schaub
bb915cbf3d Less code
Since out meters per unit conversion table is a bit spare, prefer the configured conversion.
2013-06-24 12:27:36 -06:00
Tim Schaub
129e4d5704 Fix doc bug 2013-06-24 12:21:56 -06:00
Tim Schaub
5a95d606f8 Override for clarity 2013-06-24 12:20:34 -06:00
Tim Schaub
d10eff97a2 Allow getMetersPerUnit to work without units identifier (see #814) 2013-06-24 11:34:16 -06:00
Tom Payne
bf9b0b4dd2 Merge pull request #779 from twpayne/ch-projection
Add native support for Swiss projections
2013-06-18 06:36:29 -07:00
ahocevar
37b369e0d7 Making extent optional for projections
The projection validity extent is used to generate a sensible
set of default resolutions and a sensible default tile grid.
By making it optional, we can still generate defaults - with
zoom levels that are similar to the default web mercator zoom
levels (based on fitting the world on a single tile, even if the
projection is not available for the whole world).
2013-06-17 15:24:37 +02:00
Tom Payne
cbf88de606 Don't include Swiss projections in default build 2013-06-17 12:23:29 +02:00
Tom Payne
941432af75 Use rigorous Swiss grid / EPSG:4326 transforms 2013-06-17 12:23:29 +02:00
Tom Payne
0968e2b00b Add ol.proj.EPSG2056 and factor out common code 2013-06-17 12:23:29 +02:00
Tom Payne
c02e2530f1 Add ol.proj.EPSG21781 2013-06-17 12:23:28 +02:00
Bart van den Eijnden
d552d27a35 Merge pull request #783 from bartvde/apidoc2
Add more content for the API doc (r=@twpayne,@tschaub,@fredj)
2013-06-12 11:05:07 -07:00
Tom Payne
9751bde8d1 Clean up whitespace 2013-06-12 16:05:00 +02:00
Bart van den Eijnden
8dc97790bc Add more content for the API doc
Involves additions to (there will be subsequent pull requests for other
classes):
- ol.Attribution
- ol.Collection
- ol.Expression
- ol.Feature
- ol.Geolocation
- ol.Map
- ol.Object
- ol.Overlay
- ol.Projection
- ol.View2D
- ol.control.Attribution
- ol.control.Control
- ol.control.FullScreen
- ol.control.Logo
- ol.control.MousePosition
- ol.control.ScaleLine
- ol.control.Zoom
- ol.control.ZoomSlider
- ol.dom.Input
- ol.filter.Filter
- ol.filter.Geometry
- ol.filter.Logical
2013-06-11 20:56:04 +02:00
Tom Payne
46553c719c Rename ol.projection to ol.proj 2013-05-30 18:55:58 +02:00