Commit Graph
100 Commits
Author SHA1 Message Date
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
Andreas Hocevar 60ab837025 Merge pull request #1950 from jachym/measure_example
Adding simple measure example
2014-04-11 10:06:21 +02:00
Andreas Hocevar 6826829786 Merge pull request #1971 from ahocevar/externs-instead-of-typedefs
"Cannot read property 'AttributionOptions' of undefined" error
2014-04-10 16:54:50 +02:00
Andreas Hocevar b80c6d5c61 Replace typedefs with externs
Since the compiler leaves externs untouched and learns the used
properties from object literals, this replaces the otherwise
required typedefs just fine.
2014-04-10 14:40:51 +02:00
Andreas Hocevar 04a33220a8 Parse olx.js and convert types into typedef properties 2014-04-08 11:41:24 -06:00
Andreas Hocevar 13e072cb63 Merge pull request #1955 from ahocevar/canvas-no-taint
Test canvas size with an untainted canvas
2014-04-07 13:52:09 +02:00
ahocevar d685c79e02 Use ol.dom.createCanvasContext2D and remove canvas variable 2014-04-07 13:25:49 +02:00
Andreas Hocevar 5e7790d89c Merge pull request #1956 from ahocevar/shrink-comment
Make comment about shrinking the canvas more descriptive
2014-04-06 23:55:31 +02:00
ahocevar 3848e7f823 Make comment about shrinking the canvas more descriptive 2014-04-06 23:54:59 +02:00
ahocevar 09021dffd4 Do not shrink test canvas 2014-04-06 14:29:32 +02:00
ahocevar 95795ea301 Test canvas size with an untainted canvas 2014-04-06 11:38:51 +02:00
Andreas Hocevar 6c84358619 Merge pull request #1914 from ahocevar/modify-event-propagation
Modify interaction breaks mouse wheel zoom
2014-04-04 14:18:31 +02:00
ahocevar bf06129256 Initialize snappedToVertex_ 2014-04-04 14:11:02 +02:00
ahocevar 523b51d69a Add missing goog.requires; fix types and a typo 2014-04-04 14:05:19 +02:00
ahocevar 2cb045b0b3 Better documentation for the singleclick condition 2014-04-04 14:05:19 +02:00
ahocevar f2acbd332c Use the pixelTolerance to determine whether to snap to a vertex 2014-04-04 14:05:19 +02:00
ahocevar 8fc9b23ab8 Do not return as handled unless a geometry was modified
With this change, it is more straightforward to determine
whether an event is considered as handled, which results in the
removal of the modifiable_ and lastVertexCoordinate_ states.
Instead, we only need to know whether we're on a real vertex or
a virtual one. For that a new snappedToVertex_ flag is
introduced.

To stop a click after vertex deletion from triggering a feature
selection, vertex deletion is now triggered by a configurable
event condition, which defaults to singleclick (same as in the
select interaction) with no modifier keys.
2014-04-04 14:05:18 +02:00
Andreas Hocevar e49b395cc4 Merge pull request #1940 from ahocevar/select-setmap
Handle skipped features when setting the map
2014-04-03 15:31:40 +02:00
ahocevar 8df95bc674 Handle skipped features when setting the map
When a Select interaction is removed from the map, it should
remove its selected features from the map's skippedFeatures
collection. When it is added to a map, it should add them.
2014-04-03 14:30:58 +02:00
Andreas Hocevar e44e59311b Merge pull request #1896 from ahocevar/nodragclick
Add click event as responsive alternative to singleclick
2014-04-03 13:34:14 +02:00
Andreas Hocevar 7f2a628223 Merge pull request #1928 from ahocevar/recover-from-canvas-too-big
Recover from situations where the maximum canvas size is exceeded
2014-04-03 11:46:19 +02:00
ahocevar ea58f38275 Make testCanvasSize a static function 2014-04-03 11:18:26 +02:00
ahocevar 54ba06ae3b Initialize canvasTooBig_ member 2014-04-03 11:18:12 +02:00
ahocevar 58b5fef3da Allow to make canvas smaller when it is too big
For performance reason, we only make the canvas bigger, but not
smaller. With this change, we also make it smaller, but only
when we know that its current size exceeds the maximum
dimensions.
2014-04-02 16:44:57 +02:00
ahocevar 4dce59fe95 Add method for testing whether the canvas size is valid
This is a way to detect whether a canvas exceeds the maximum
dimensions if these are limited on the target device. See
https://developer.apple.com/library/ios/documentation/AppleApplications/Reference/SafariWebContent/CreatingContentforSafarioniPhone/CreatingContentforSafarioniPhone.html
for limitations on iOS devices.
2014-04-02 16:44:39 +02:00
Andreas Hocevar 39bf863335 Merge pull request #1886 from ahocevar/touchend-button
Zoom happens twice on Android browser
2014-04-01 17:07:34 +02:00
ahocevar a3be9e720a Register pointer event handlers as disposable 2014-04-01 15:31:39 +02:00
ahocevar e05cff670b Use pointer events for button clicks 2014-04-01 13:46:58 +02:00
Andreas Hocevar 37eea9340e Merge pull request #1283 from ahocevar/delete-vertex
Add a way to delete vertices with the Modify interaction
2014-03-28 12:39:28 +01:00
ahocevar 8b99fd9bc1 Updates to pass jshint validation 2014-03-28 12:02:08 +01:00
ahocevar b9cd512ffc Lower pixel tolerance to avoid accidental vertex deltion 2014-03-28 11:37:06 +01:00
ahocevar e612330dd7 Add a way to delete vertices with the Modify interaction
After this change, vertices can be deleted by simply clicking on
them. This is the same behaviour as e.g. in geojson.io.
2014-03-28 11:36:13 +01:00
ahocevar 02907b26ed Continue using singleclick for getfeatureinfo 2014-03-27 18:34:47 +01:00
ahocevar 30fc1a29fb Add unit tests for click event 2014-03-27 18:33:17 +01:00
ahocevar 7bfa15c0fd Add click event as responsive alternative to singleclick
The singleclick event makes the application feel slow because
of the 250 ms delay that is used to rule out a dblclick.
2014-03-27 18:33:17 +01:00
Andreas Hocevar 47b82f0f11 Merge pull request #1906 from ahocevar/fix-event-docs
Do not delete event and fires doclets
2014-03-27 13:00:37 +01:00
ahocevar d4eb5dd2ee Use a more visually appealing margin for descriptions 2014-03-27 13:00:08 +01:00
ahocevar a5d8f463ff Clean up
Only mark symbol as unexported when it is not in the API, and
no longer extract links from fires annotations because all links
are handled now.
2014-03-27 12:37:01 +01:00
ahocevar 15b0bc719e Do not loop through parents
Now that we use the parseComplete event, we walk through all
doclets in the loop anyway.
2014-03-27 01:56:31 +01:00
ahocevar a1d9491d62 Do not delete event and fires doclets 2014-03-27 01:18:59 +01:00
Andreas Hocevar 0dcdd58396 Merge pull request #1904 from ahocevar/doc-improvements
API doc improvements
2014-03-26 23:47:02 +01:00
ahocevar cc1fceab05 Do not query the array twice 2014-03-26 23:46:42 +01:00
Andreas Hocevar d148d814b2 Merge pull request #1901 from ahocevar/canvasimmediate-less-exports
Do not export the ol.render.canvas.Immediate constructor
2014-03-26 18:43:16 +01:00
ahocevar 46ec3209bd Make ol.View2D available when exploring olx.MapOptions 2014-03-26 18:38:26 +01:00
ahocevar 19ed446f43 Make ol.render.canvas.Immediate available in the docs 2014-03-26 18:33:45 +01:00
ahocevar e5edb5c0e3 Also consider linked symbols as documented 2014-03-26 18:33:15 +01:00
ahocevar f129a68248 Only add symbols to the unexported array once
This basically fixes a typo that caused unexported symbols to
be added to the unexported array multiple times.
2014-03-26 18:32:36 +01:00