4d9975754f
Mapbox vector layer
2020-05-03 16:07:27 -06:00
054af09032
Make code prettier
...
This updates ESLint and our shared eslint-config-openlayers to use Prettier. Most formatting changes were automatically applied with this:
npm run lint -- --fix
A few manual changes were required:
* In `examples/offscreen-canvas.js`, the `//eslint-disable-line` comment needed to be moved to the appropriate line to disable the error about the `'worker-loader!./offscreen-canvas.worker.js'` import.
* In `examples/webpack/exapmle-builder.js`, spaces could not be added after a couple `function`s for some reason. While editing this, I reworked `ExampleBuilder` to be a class.
* In `src/ol/format/WMSGetFeatureInfo.js`, the `// @ts-ignore` comment needed to be moved down one line so it applied to the `parsersNS` argument.
2020-04-06 12:54:09 -06:00
0a6468d7ae
Remove plugin for @inheritDoc
2020-04-04 13:57:48 +02:00
dd44ecf185
Only document enums when they have API properties
2020-03-28 14:17:56 +01:00
873cccc4f3
Add default exported enums to apidoc
2020-03-12 22:29:46 +01:00
f2477622c3
Remove redundant check if doclet kind is typedef
2020-03-12 22:29:34 +01:00
058ca59233
Also correctly detect default exports without an identifier
2020-03-12 21:36:19 +01:00
1d7d7a7eef
Sort events / observables in all cases
...
Right now this only changes the order of events of the UrlTile class.
2020-03-01 00:25:11 +01:00
d28be3c160
Fix building apidoc on windows
2020-02-28 21:44:06 +01:00
47ed2963c4
Default exported classes have same prettyname as modules
2020-02-27 22:57:55 +01:00
c0f058f5cf
Variable should be reset on each loop but wasn't
...
The ancestors variable is always set once the first augmented doclet is found.
The incompleteDoclet variable is also not reset between loops.
2020-02-07 00:08:14 +01:00
2e4f989d7b
Store api members as object map instead of array.
2020-02-07 00:08:14 +01:00
afba861ab5
Merge pull request #10543 from MoonE/jsdoc-api-mustnothavevalue
...
@api tag must not have a value.
2020-01-20 09:33:28 +01:00
e2dc67546e
Only generate module apidoc pages when it contains api tags
2020-01-19 15:51:48 +01:00
9cc7ef4b96
Use correct config for tags which must not have a value.
2020-01-18 20:15:10 +01:00
b6bd35c15c
Fix observable properties documentation
2019-07-14 10:15:00 +02:00
4ea28333f8
Avoid duplicates in api docs
2019-06-17 08:15:17 +02:00
b3e770226f
Smaller scope
2019-04-28 16:03:54 -06:00
981328576f
Remove unused classes lookup
2019-04-28 16:00:43 -06:00
72d38fa929
Fixes missing methods with @inheritdoc
...
- This sets ignore to false if a method tagged with
inheritdoc has a matching ancestor. It also stops iterating
when a match is found.
- Outdated TODO is removed, too.
2019-03-12 15:07:03 +01:00
b50749e1ea
Use jsdoc-plugin-typescript
2018-10-29 19:15:01 +01:00
ba20c6333b
Move convert-types plugin to place for common use
2018-10-25 21:49:02 +02:00
453a723005
Improve link handling in API docs
2018-10-24 17:52:42 +02:00
3a42a0859c
Fix event documentation
2018-10-23 18:05:43 +02:00
0593c352af
Avoid duplicate documentation
2018-10-23 18:05:26 +02:00
deb6c093a8
Update plugin chain to support JSDoc import types
2018-10-23 18:04:26 +02:00
0b21d1a6fc
Document anonymous default exports
2018-10-23 18:01:46 +02:00
52465df88a
Also add object properties and non-object typedefs
2018-05-13 10:26:29 -05:00
6cd6e3cc83
Normalize module paths to ignore ~/. differences
2018-05-13 10:26:29 -05:00
554968f8f2
Inline constructor options
2018-05-13 10:26:29 -05:00
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
636369181b
Bring back basic api documentation
2018-05-09 12:01:16 +02:00
167bc1ec78
Remove externs/oli.js
2018-05-08 08:38:34 -06:00
d93a76dcb9
Remove olx.js and code that uses it
2018-04-19 18:13:55 -06:00
a09f7fb3bb
Clean lint from jsdoc config
2018-04-19 17:32:54 -06:00
b3ddcd4ed9
Avoid duplicates in Observables list
2017-06-12 08:24:44 +02:00
f5aea97d3b
All @api annotations imply stability
2017-02-06 09:22:05 -07:00
c00906cde9
Add Event to ol.Object
2016-12-06 14:49:43 -07:00
0dca194525
Handle types in arrays etc.
2016-06-04 00:27:25 +02:00
9e980663ee
Remove api annotations from typedefs in olx.js
2016-06-03 10:38:55 +02:00
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
34dd7b76b1
Use jsdoc@3.4.0
2015-11-17 18:04:16 -07:00
85ca4e1888
Update JSDoc to get async publish support
2015-10-31 13:30:30 -06:00
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
31f2e334cf
Reinstate inheritdoc to fix #4082
2015-09-09 07:43:22 +02:00
0a99d0f211
Automatically mark required options in API-docs
2015-09-03 16:44:12 +02:00
6812de6a77
Upgrade JSDoc to 3.3.2 and remove obsoleted plugins
2015-08-04 22:04:15 +02:00
ad83f83f2c
To do call toLowerCase when forming a change:property event
2014-09-18 18:44:45 +02:00
787688ef33
Copy stability from doclet to observable
2014-08-22 17:27:29 -06:00
f17c33f631
Rename buildcfg to config
2014-08-22 07:28:05 -06:00
Tim Schaub
Andreas Hocevar
Maximilian Krög
Kai Volland
Marc Jansen
Björn Harrtell
Éric Lemoine