ahocevar
527331a797
Make docs work when published
2018-05-13 11:15:31 -05:00
ahocevar
52465df88a
Also add object properties and non-object typedefs
2018-05-13 10:26:29 -05:00
ahocevar
6cd6e3cc83
Normalize module paths to ignore ~/. differences
2018-05-13 10:26:29 -05:00
ahocevar
554968f8f2
Inline constructor options
2018-05-13 10:26:29 -05:00
ahocevar
cc8cffd324
Faster processing by omitting src/index.js
2018-05-13 10:26:29 -05:00
ahocevar
e810387956
Fix some JSDoc issues
...
Also makes a few minor changes to the template, so it can be used until
we have a new doc generation process. JSDoc output is written to
build/apidoc.
2018-05-10 17:14:17 +02:00
ahocevar
636369181b
Bring back basic api documentation
2018-05-09 12:01:16 +02:00
Tim Schaub
167bc1ec78
Remove externs/oli.js
2018-05-08 08:38:34 -06:00
Tim Schaub
d93a76dcb9
Remove olx.js and code that uses it
2018-04-19 18:13:55 -06:00
Tim Schaub
a09f7fb3bb
Clean lint from jsdoc config
2018-04-19 17:32:54 -06:00
Frederic Junod
2278715f85
Remove ol.DeviceOrientation link from API index
...
`ol.DeviceOrientation` is now deprecated
2017-11-24 12:39:05 +01:00
Andreas Hocevar
9400d600ee
Fix jsdoc paths
2017-09-06 21:13:45 +02:00
Viet Hang Nguyen
a4509e3246
Fix typo
2017-08-29 22:14:55 +02:00
Andreas Hocevar
86d0074386
Print ES6 import hint on each doc page
2017-08-15 19:17:06 -04:00
Andreas Hocevar
4d0e106d98
Change paths for jsdoc 3.5
2017-07-10 12:02:12 +02:00
Andreas Hocevar
b3ddcd4ed9
Avoid duplicates in Observables list
2017-06-12 08:24:44 +02:00
Tim Schaub
f5aea97d3b
All @api annotations imply stability
2017-02-06 09:22:05 -07:00
Thomas Chandelle
5938db1459
Set highlight style to the active anchor
2017-01-11 13:13:04 +01:00
Andreas Hocevar
7424ee91e3
Remove the '3' from OpenLayers
2017-01-02 23:03:03 +01:00
Tim Schaub
c6c105b62f
Shared module for map browser event type enum
2016-12-27 13:48:50 -07:00
Tim Schaub
fbbc42f8f9
Merge pull request #6226 from tchandelle/doc-anchors
...
Improve the headers styles in the api doc
2016-12-09 09:42:38 -07:00
Tim Schaub
c00906cde9
Add Event to ol.Object
2016-12-06 14:49:43 -07:00
Thomas Chandelle
b77b5e5a55
Replace the anchor by an empty div element
2016-11-29 17:00:29 +01:00
Thomas Chandelle
741494098e
Fix link anchor to static members
2016-11-09 13:30:57 +01:00
Frederic Junod
bd635ed01f
Load the examples resources with HTTPS
2016-08-23 13:52:16 +02:00
Daniel Reiter
ce4e6d49f5
Fix github line links on jsdoc pages
...
Github line links only work with a capital `L`.
2016-08-02 11:05:10 -05:00
Andreas Hocevar
0dca194525
Handle types in arrays etc.
2016-06-04 00:27:25 +02:00
Andreas Hocevar
9e980663ee
Remove api annotations from typedefs in olx.js
2016-06-03 10:38:55 +02:00
Andreas Hocevar
eddd006fcf
Document typedefs and enums used by API symbols
...
It is no longer necessary to add api annotations to typedefs and enums
that are used by API symbols.
2016-06-03 09:28:53 +02:00
Peter Robins
3b1c76a1da
Correct typo in config/jsdoc/api/readme.md
2016-06-02 15:29:41 +01:00
Peter Robins
1a1d55d54e
Add API policy to docs landing page
2016-05-17 14:27:12 +00:00
Andreas Hocevar
e74434299e
Fix incorrect source links
2016-05-12 18:51:54 +02:00
Andreas Hocevar
0d2b833e06
Use a div instead of alert for version warning
...
With this change, it is also no longer necessary to display the version in the
navigation bar. The accidently removed doctype is also brought back.
2016-05-12 17:13:44 +02:00
Andreas Hocevar
d59ace1a61
Improve code readability with better comments
2016-05-11 15:46:39 +02:00
Andreas Hocevar
d27ea0974e
Fix source links, display version and warn about outdated docs
2016-05-11 12:45:58 +02:00
Andreas Hocevar
34139f4dce
Fix apidoc landing page markup
2015-12-17 15:13:26 +01:00
Andreas Hocevar
d9bb3adbe8
Improve vector tile related docs
2015-12-11 12:01:24 +01:00
Frederic Junod
7149113ab6
Remove unused files
2015-12-01 15:50:51 +01:00
Tim Schaub
34dd7b76b1
Use jsdoc@3.4.0
2015-11-17 18:04:16 -07:00
Tim Schaub
85ca4e1888
Update JSDoc to get async publish support
2015-10-31 13:30:30 -06:00
Michael Kalbermatten
9543cc10dd
Remove invalid link to featureOverlay in API doc
2015-09-17 11:12:54 +02:00
Marc Jansen
da627dda4b
Merge pull request #4079 from marcjansen/mark-required-options
...
Automatically mark required options in API-docs
2015-09-15 16:13:36 +09:00
Björn Harrtell
31f2e334cf
Reinstate inheritdoc to fix #4082
2015-09-09 07:43:22 +02:00
Marc Jansen
0a99d0f211
Automatically mark required options in API-docs
2015-09-03 16:44:12 +02:00
Tim Schaub
6dc7f2cfec
Remove footer with timestamp
2015-08-07 11:22:07 -06:00
Björn Harrtell
6812de6a77
Upgrade JSDoc to 3.3.2 and remove obsoleted plugins
2015-08-04 22:04:15 +02:00
Andreas Hocevar
3595c2cce7
Document change events properly
...
With this change, the generic 'change' event is properly documented, as
all other events. It is no longer necessary to annotate `@fires change` for
every ol.Observable subclass.
2015-07-18 15:27:16 +02:00
Frederic Junod
00ce2f0f58
Remove dead link in api doc
...
Fixes #3596
2015-04-20 15:07:39 +02:00
Tim Schaub
8fd2e9f79f
Untangle resources and put built examples in the build dir
2015-04-17 06:22:38 -06:00
Tim Schaub
e5c6915761
Update documentation
2015-04-07 08:35:48 -06:00
