ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
14,212 Commits 5 Branches 232 Tags
3a0d0c7290d2538eb181529aed5dda0a6d2897a9
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Andreas Hocevar 3a0d0c7290 Remove transient jsdoc dependencies 
alpha9 has the dependencies fixed again, so no need to keep taffydb and
underscore around.
 2014-07-08 21:38:16 +02:00
Andreas Hocevar 9b1e9dbc8e Merge pull request #2317 from ahocevar/export-transform 
Make transform exportable
 2014-07-07 11:19:04 +02:00
Andreas Hocevar 1933d809e2 Export transform 
ol.ObjectAccessor#transform is used in the bind-input example. Why the
example works without this export is a mystery to me. Either way, we
will want this in the docs.
 2014-07-07 10:45:15 +02:00
Andreas Hocevar 60f283d5c0 Merge pull request #2279 from ahocevar/show-sketch-vertex 
Show sketch vertex for all geometry types
 2014-07-01 12:04:40 +02:00
Andreas Hocevar 29370a04aa Show sketch vertex for all geometry types 2014-07-01 11:52:21 +02:00
Andreas Hocevar efc3e3244a Merge pull request #2254 from elemoine/replaygroup 
Use replay groups for feature overlays
 2014-06-27 12:59:06 +02:00
Andreas Hocevar cf13cb5e32 Fix remaining API doc issues with squared tolerance vs. tolerance 2014-06-27 12:20:16 +02:00
Andreas Hocevar 80fa0be42f Use setStyle in the constructor 2014-06-27 12:14:22 +02:00
Andreas Hocevar f67767aaf0 Add ol.renderer.vector.getSquaredTolerance and ol.SIMPLIFY_TOLERANCE 2014-06-27 12:10:46 +02:00
Andreas Hocevar 2171c92b5c Add new tests for FeatureOverlay 
In the process of creating these tests, a bug with setting this._style
was also fixed.
 2014-06-27 11:46:47 +02:00
Andreas Hocevar 1551e6e7ff Improved forEatchFeatureAtPixel docs 2014-06-26 15:17:29 +02:00
Andreas Hocevar d2e4603171 Merge pull request #2252 from probins/patch-1 
Fix broken links in api docs landing page
 2014-06-26 13:24:20 +02:00
Andreas Hocevar ba2d49d715 Finish the replay group after dispatching the compose event 2014-06-26 13:16:34 +02:00
Andreas Hocevar 4679a7d4fb Merge pull request #2138 from probins/mapoptions 
Document map options more thoroughly
 2014-06-25 09:35:56 +02:00
Andreas Hocevar 85ddd2446e Add endGeometry after hit detection stroke and fill 2014-06-24 12:23:47 +02:00
Andreas Hocevar 4e52224c12 Add example 2014-06-18 13:34:57 +02:00
Andreas Hocevar 3fdd0e4bf7 Merge pull request #2202 from probins/tvformat 
Add missing format option to TileVector docs
 2014-06-16 11:03:43 +02:00
Andreas Hocevar eb8c2ab339 Merge pull request #2203 from probins/classdesc 
Add classdesc to remaining vector classes
 2014-06-16 11:02:23 +02:00
Andreas Hocevar 0d59deb6ba Merge pull request #2206 from probins/nostatic 
Remove static button in docs sidebar if none
 2014-06-16 10:55:01 +02:00
Andreas Hocevar 4925ac9339 Merge pull request #2199 from probins/abstract 
Add standard docs text to abstract base classes
 2014-06-14 14:17:46 +02:00
Andreas Hocevar 66d72519c3 Merge pull request #2191 from ahocevar/tile-function-annotation 
Mark abstract method as function for JSDoc to pick it up
 2014-06-12 15:03:52 +02:00
Andreas Hocevar 4eab46e41b Mark abstract method as function for JSDoc to pick it up 
This leaves aside the question whether getImage needs to be
defined as abstract method in a base class that does not know
about images, but at least it makes the documentation appear
correctly in ol.tile.Image.
 2014-06-12 14:43:49 +02:00
Andreas Hocevar b411ccaa5b Merge pull request #2187 from ahocevar/fix-jsdoc 
Manually add jsdoc dependencies
 2014-06-11 13:04:21 +02:00
Andreas Hocevar 28d4e5a6c9 Manually add jsdoc dependencies 
Looks like there is a version mismatch with the taffydb and
underscore dependencies of jsdoc, so we add them here manually.
 2014-06-11 12:06:02 +02:00
Andreas Hocevar 90974a0721 Merge pull request #2184 from ahocevar/google-no-kinetic 
Restore synchronized map panning in google-map example
 2014-06-11 00:37:12 +02:00
Andreas Hocevar c8c0f087f0 Restore synchronized map panning in google-map example 2014-06-10 16:11:40 +02:00
Andreas Hocevar f27c91e27f Merge pull request #2130 from adube/fix-example-gmaps-zooms 
Fix GoogleMaps example view max zoom levels
 2014-06-09 22:22:34 +02:00
Andreas Hocevar cc1b7cac48 Merge pull request #2125 from ahocevar/loadingstrategy-docs 
Make loading strategies appear in the docs
 2014-05-27 15:59:10 +02:00
Andreas Hocevar 45805f7158 Make loading strategies appear in the docs 2014-05-27 15:38:31 +02:00
Andreas Hocevar 7732a10bbf Merge pull request #2116 from ahocevar/no-imagestyle 
Do not make ol.style.Image exportable
 2014-05-27 08:02:51 +02:00
Andreas Hocevar 605b8278ea Do not make ol.style.Image exportable 
Application developers should use its subclasses.
 2014-05-26 19:26:58 +02:00
Andreas Hocevar 0e7f86ea17 Merge pull request #2072 from ahocevar/no-oli-docs 
Do not include oli.* symbols in the API documentation
 2014-05-23 10:52:49 +02:00
Andreas Hocevar f903849882 Remove all docstrings from oli.js 
Instead, make sure that the properties are documented in the
implementing class.
 2014-05-22 18:00:10 +02:00
Andreas Hocevar 547334e211 Move oli.* stability notes to the corresponding ol.* symbol 2014-05-22 16:01:35 +02:00
Andreas Hocevar 2caa1139a1 Move object literals defined in ol3 to a separate section 2014-05-22 15:51:41 +02:00
Andreas Hocevar 08cdeaacb4 Clean up api.js 2014-05-22 15:51:21 +02:00
Andreas Hocevar eb6a938062 Do not document object literals as interfaces 
Instead, object literals with properties that should not be
renamed can go in externs/olx.js.
 2014-05-22 15:48:47 +02:00
Andreas Hocevar e050c905e2 Do not include oli.* symbols in the inheritance chain 2014-05-22 15:48:46 +02:00
Andreas Hocevar dca88668ab Merge pull request #2095 from ahocevar/test-geometry-name 
Test that a custom geometry works
 2014-05-21 15:08:47 +02:00
Andreas Hocevar e530758b36 Test that a custom geometry works 2014-05-21 15:08:11 +02:00
Andreas Hocevar cabd436b4c Merge pull request #2082 from ahocevar/custom-exports-target 
Allow to specify an objectToExportTo for goog.exportSymbol
 2014-05-21 13:51:52 +02:00
Andreas Hocevar 3447f93bfe Document the new namespace option 2014-05-20 21:56:32 +02:00
Andreas Hocevar cd4092f3e0 Allow to specify an objectToExportTo for goog.exportSymbol 
This allows users to build ol3 without anything exposed in the
global namespace. This can e.g. be useful for creating an ol3
AMD module, by simply using a build configuration with
"define('ol',function(){var o={};%output%return o.ol;});" as
"output_wrapper".
 2014-05-20 21:49:26 +02:00
Andreas Hocevar 6185005c3f Merge pull request #2077 from ahocevar/event-stability 
Document event stability even when there is no description
 2014-05-16 10:03:30 +02:00
Andreas Hocevar aaf21198d3 Document event stability even when there is no description 2014-05-15 23:02:01 +02:00
Andreas Hocevar c70497856c Merge pull request #2075 from ahocevar/api-docs-improved 
More API doc improvements
 2014-05-15 22:35:53 +02:00
Andreas Hocevar 687abda9fb Need to be more specific about the coordinate format now. 2014-05-15 20:56:09 +02:00
Andreas Hocevar b348a4f8f9 Add some margin between the 'static' tag and the name 2014-05-15 20:29:46 +02:00
Andreas Hocevar d163f60e34 Make sure that opt_layout is listed as optional 2014-05-15 20:29:16 +02:00
Andreas Hocevar b2805c58de Better document which events are fired 
The map does not fire ol.render.Event#render. Change events are
now only listed for classes that fire them, and a description
about when they are fired is added.
 2014-05-15 20:28:09 +02:00
Andreas Hocevar a75d944311 Allow custom events and do not collect events from methods 2014-05-15 20:25:26 +02:00
Andreas Hocevar 0d10314d4f Make sure that ol.source.wms.ServerType is documented 2014-05-15 17:06:19 +02:00
Andreas Hocevar 97bae045db Fix documentation typos 2014-05-15 17:05:40 +02:00
Andreas Hocevar 754ef24b0c List default controls and interactions 2014-05-15 17:04:58 +02:00
Andreas Hocevar b2554cab41 Mark optional and repeatable arguments 2014-05-15 16:58:13 +02:00
Andreas Hocevar fc88db53f6 Make types look the same everywhere 2014-05-15 16:57:47 +02:00
Andreas Hocevar 720052de12 New landing page 2014-05-15 16:54:33 +02:00
Andreas Hocevar 81a85fe0e2 Merge pull request #2061 from eshon/master 
Some suggested color changes to apidoc template items
 2014-05-14 22:45:21 +02:00
Andreas Hocevar 3a8aaea6c7 Merge pull request #2068 from ahocevar/apidoc-imprved 
Only document arguments of exported constructors
 2014-05-14 21:08:17 +02:00
Andreas Hocevar a613e01677 Only document arguments of exported constructors 2014-05-14 09:06:26 +02:00
Andreas Hocevar efdf05f0d1 Merge pull request #2051 from ahocevar/fix-returns 
Apidoc: first word of '@return' not displayed
 2014-05-09 10:43:28 -05:00
Andreas Hocevar 90ffde52f2 Make sure that links are clickable 
Because we set a padding of 50px on anchorable elements to make
sure they are not obscured by the header, we need to raise the
z-index of links so they are not obscured by these paddings.
 2014-05-09 10:03:17 -05:00
Andreas Hocevar f95e23deeb Do not hide the first word of returns 2014-05-09 10:02:13 -05:00
Andreas Hocevar 354a93b2f7 Merge pull request #2049 from ahocevar/anchor-line-numbers 
Fix anchor offsets for line numbers
 2014-05-07 15:05:22 -05:00
Andreas Hocevar 564d3cda12 Fix anchor offsets for line numbers 2014-05-07 15:01:48 -05:00
Andreas Hocevar be73885e37 Merge pull request #2043 from ahocevar/nicer-api-docs 
Nicer API docs
 2014-05-07 09:20:22 -05:00
Andreas Hocevar 0d4c7dc1fc Better match the ol3 color theme 2014-05-07 08:40:02 -05:00
Andreas Hocevar c57e9dc047 Better readable color for type links 2014-05-06 14:12:38 -05:00
Andreas Hocevar e2c9dd279d Switch to the Jaguar theme 
In addition to a nicer layout, this adds a searchable sidebar
and a source code viewer.
 2014-05-06 12:46:59 -05:00
Andreas Hocevar e6dbb61d68 Document raw geometry types 2014-05-06 12:45:53 -05:00
Andreas Hocevar 3f2f7e3603 Fix indentation 2014-05-06 12:45:53 -05:00
Andreas Hocevar 436bbdecd0 Document ol.Pixel 2014-05-06 12:45:53 -05:00
Andreas Hocevar 959e14c31a Handle observables and fires augments in plugins 
This makes it easier to switch themes.
 2014-05-06 10:14:28 -05:00
Andreas Hocevar c2a9e95a37 Make sure anchors are not obscured by the header 2014-05-05 12:40:48 -05:00
Andreas Hocevar 5f54b45fa2 Add readme note about observable properties 2014-05-05 09:52:32 -05:00
Andreas Hocevar 61b732b8f7 Make sure that parent classes are not marked undocumented 2014-05-05 09:40:28 -05:00
Andreas Hocevar b1126c9373 Inline events and also list method events with the class 2014-05-05 09:35:33 -05:00
Andreas Hocevar 52444b1366 Inherit events 2014-05-04 18:29:18 -05:00
Andreas Hocevar b444714c55 No longer need to remove dead links 
There should be no dead links any more, now that we include
doclets for the whole inheritance chain of a class.
 2014-05-04 18:28:19 -05:00
Andreas Hocevar ea5df18c72 Remove unused require 2014-05-04 14:51:06 -05:00
Andreas Hocevar 8ee9f7cb6a Simplify the way we annotate observable properties 
We no longer add observable annotations to the constructor.
Instead, we just mark getters (and for read/write properties
also setters) with an observable annotation.
 2014-05-03 16:04:25 -04:00
Andreas Hocevar 0f072c0ec1 List subclasses for each class 
With this change, we no longer need to link to implementations
or subclasses manually.
 2014-05-03 15:32:39 -04:00
Andreas Hocevar db5b2e284a Do not remove classes that other classes inherit from 2014-05-03 12:41:52 +02:00
Andreas Hocevar 6cea9a9d9a Avoid dead links 
Because we remove doclets that are not part of the API, there
are cases where linkto will create a link to an undocumented
doclet. We now replace such links with the longname of the
doclet.
 2014-05-03 12:41:52 +02:00
Andreas Hocevar 5a13488b11 Stop adding ObjectEvent links manually 
Now that the links are removed from event annotations, we no
longer need to do this, because inheritance works.
 2014-05-02 12:06:48 +02:00
Andreas Hocevar b7f6e2d9b9 Fix quotes 2014-05-02 12:06:48 +02:00
Andreas Hocevar d6722ddc6f Mark undocumented doclets as undocumented 
To give other plugins access to doclets that are not part of
the API, we have to mark them undocumented instead of removing
them. They will be removed by JSDoc before publishing anyway.
 2014-05-02 12:06:48 +02:00
Andreas Hocevar 7b4c240a5a Merge pull request #2004 from ahocevar/bind-webgl 
Bind input example is broken since default renderer has changed
 2014-05-02 11:08:32 +02:00
Andreas Hocevar 8e387f385a Add missing namespace annotation 2014-05-01 22:17:57 +02:00
Andreas Hocevar e7e1ef7534 Show inherited observable properties 2014-05-01 22:17:57 +02:00
Andreas Hocevar 25dd0127e9 Recursively document subparams and span table columns 2014-05-01 22:17:57 +02:00
Andreas Hocevar 7271b50d5a Simplify fires annotations 2014-05-01 22:17:56 +02:00
Andreas Hocevar f22aac1e22 Only use the inheritdoc plugin once 2014-05-01 22:17:56 +02: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 29b643c7b0 Inline object literals from olx.js 2014-04-29 09:53:07 -06:00
Andreas Hocevar cdd1922350 Document purpose and use of oli.js and olx.js 2014-04-29 09:53:06 -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
Andreas Hocevar aaf6101d0f Include symbols from oli.js using interface and implements tags 
Instead of regex parsing, we define tags for interface and
implements.
 2014-04-29 09:53:06 -06:00
Andreas Hocevar b758d92790 Use symbols.json for determining the API 
Also to get rid of regular expression parsing, instead of
collecting exports for observables from the source files, we use
the 'observable' annotations.
 2014-04-29 09:53:06 -06:00
Andreas Hocevar 32dda342aa Only show controls for WebGL settings when WebGL is used 2014-04-22 16:29:53 +02:00