Commit Graph

202 Commits

Author SHA1 Message Date
Kai Volland 9860699d5f Introduces import snippets for static functions
Adds snippets for import of modules and their
exported functions to the API documentation.
2019-04-04 10:07:55 +02:00
Kai Volland 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
ahocevar e8243b73b5 Fix transpilation 2019-03-11 10:11:05 +01:00
ahocevar 5e16bae134 Provide sources in ol package 2019-02-03 23:46:37 +01:00
ahocevar 56a60631bc Allow users to opt out of tracking 2019-01-02 07:36:25 +01:00
ahocevar b50749e1ea Use jsdoc-plugin-typescript 2018-10-29 19:15:01 +01:00
ahocevar e239eb338f Use webpack instead of rollup for the legacy build
This also changes the target path of the legacy build to build/legacy
2018-10-25 22:00:22 +02:00
ahocevar 6ceb03f86b Use typescript-plugin for generate-info task 2018-10-25 21:52:58 +02:00
ahocevar ba20c6333b Move convert-types plugin to place for common use 2018-10-25 21:49:02 +02:00
ahocevar 453a723005 Improve link handling in API docs 2018-10-24 17:52:42 +02:00
ahocevar 3a42a0859c Fix event documentation 2018-10-23 18:05:43 +02:00
ahocevar 0593c352af Avoid duplicate documentation 2018-10-23 18:05:26 +02:00
ahocevar 724d141d3a Fix links and navigation 2018-10-23 18:05:02 +02:00
ahocevar deb6c093a8 Update plugin chain to support JSDoc import types 2018-10-23 18:04:26 +02:00
ahocevar 0b21d1a6fc Document anonymous default exports 2018-10-23 18:01:46 +02:00
ahocevar cd2f0f60d6 Make link texts consistent with docs 2018-10-23 17:40:51 +02:00
Tim Schaub d12ef20b12 Use Array<Foo> instead of Array.<Foo> 2018-07-25 18:32:43 -07:00
Tim Schaub d8b290966b Tracking 2018-07-21 09:11:30 -06:00
Tim Schaub b8c9125602 Remove lint 2018-07-18 10:35:54 -06:00
Tim Schaub 7c6755d3ec Scripts for generating the package and legacy build 2018-07-17 14:48:17 -06:00
ahocevar 04e825e49a Use rollup instead of webpack for the full build 2018-05-29 15:24:51 +02:00
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
Tim Schaub de9d9ffce1 Throw an error with more detail in publish.js and remove olx.control 2018-03-11 11:17:45 -06:00
Tim Schaub 449568802a Remove unused deps, unused tasks, and outdated info 2018-03-03 13:25:46 -07:00
Andreas Hocevar 9c12b351e5 Use webpack for full build, find something else for type checking 2018-02-08 19:51:28 +01:00
Andreas Hocevar efd9f2c088 Handle modules 2018-02-08 19:51:26 +01:00
Andreas Hocevar 08763ef139 Remove stability from info 2018-02-08 19:51:26 +01:00
Tim Schaub 93411a2b91 Script to build examples 2017-12-12 06:55:17 -07: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 2260d92436 Return promise to avoid truncated stdout output 2017-07-10 12:02:33 +02: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
Andreas Hocevar ddeb9c84e2 Merge pull request #6461 from tchandelle/codepen
Add button to edit examples in CodePen
2017-02-08 11:24:46 +01:00
Thomas Chandelle 89dd4af9cb Remove JSFiddle 2017-02-08 09:04:16 +01:00
Tim Schaub f5aea97d3b All @api annotations imply stability 2017-02-06 09:22:05 -07:00
Guillaume Beraudo 687ef25649 Ignore unused local variable in all examples compile
This makes it consistent with the eslint configuration for examples in
examples/.eslintrc.
2017-01-31 14:40:18 +01:00
Frederic Junod 3e4afa6ddf Update closure-util to v1.16.0 2017-01-30 17:16:01 +01:00
Frederic Junod 68f493fc90 Revert "Remove 'analyzerChecks' from jscomp_off compiler option"
This reverts commit 5632084441.
2017-01-30 17:16:01 +01:00