Commit Graph

210 Commits

Author SHA1 Message Date
Tim Schaub bbbca0ab78 Update ESLint config and plugins 2022-05-23 15:01:07 -06:00
Andreas Hocevar 53239f7b1e Document difference between Vector and VectorImage layers 2022-02-12 12:57:19 +01:00
Maximilian Krög 14c5e9a7e8 Load api navigation dynamically to reduce needed disk space 2022-01-22 22:29:33 +01:00
Andreas Hocevar b86f9df8bd Account for removed default export of marked 2021-11-08 16:35:23 +01:00
Andreas Hocevar 5901751f43 Merge pull request #12624 from ahocevar/apidoc-undefined
Improve API docs for optional properties
2021-09-05 09:30:04 +02:00
Andreas Hocevar 814d70b1cc Add more tests 2021-08-18 17:54:48 +02:00
Andreas Hocevar 000461993b Add undefined as type when optional and no default 2021-08-12 12:18:51 +02:00
Simon Seyock 9344de5740 remove unneeded code 2021-06-17 18:54:29 +02:00
Simon Seyock aa99de4a6b parse comment for templates 2021-06-17 18:54:29 +02:00
Simon Seyock a5d0b61947 Allow options to be generic in jsdoc 2021-06-17 18:54:29 +02:00
Maximilian Krög 40f8e69675 Fix legacy build
The build process failed because webpack does not allow failed imports
when it is run as a module.
This detects modules with default exports and only generates import
statements for default exports where they are available.
2021-05-02 23:49:50 +02:00
Tim Schaub c301d2413b Modules all the way 2021-05-01 10:17:04 -06:00
Maximilian Krög 0d5d346bcd Update links to external resources 2021-02-08 19:40:05 +01:00
Simon Seyock c15faa19fc enable check-types 2021-02-03 13:59:34 +01:00
Simon Seyock 808868ad1f Fixed some jsdoc issues. 2021-02-02 12:15:30 +01:00
Andreas Hocevar f242b7d618 Update inline comments 2020-11-05 10:40:45 +01:00
Andreas Hocevar 68d6a6b84c Add all symbols to the legacy build 2020-11-04 19:56:24 +01:00
Maximilian Krög f9ffd75132 dd / dt tag must be inside dl tags 2020-08-23 16:15:50 +02:00
Maximilian Krög b33b2ce9a4 Don't generate empty nameContainer tag 2020-08-23 16:08:14 +02:00
Maximilian Krög efdfb169aa Equal margin for horizontal line 2020-08-23 16:08:14 +02:00
Maximilian Krög 0a136afe15 Navigate to first search result on enter 2020-08-23 16:08:14 +02:00
Maximilian Krög 411d5bfb03 Charset meta tag should be in the first 1024 bytes 2020-08-23 16:08:14 +02:00
Maximilian Krög 477c331a4c Create source code links during apidoc creation 2020-08-23 16:08:14 +02:00
Maximilian Krög d74da75561 Graceful fallback for internet explorer 11 2020-08-23 12:21:47 +02:00
Maximilian Krög d9bc466f43 Better scroll behaviour for apidocs 2020-08-23 11:18:19 +02:00
Maximilian Krög 5e30b15860 Fix link to workshop / download 2020-08-04 21:47:58 +02:00
Maximilian Krög e723061f9b Add empty alt tag to logo 2020-07-26 19:31:57 +02:00
Andreas Hocevar 2b23052d23 Mark active nav item 2020-07-26 17:41:16 +02:00
Andreas Hocevar f70374e453 Make header and menu navigation consistent with web site 2020-07-26 17:15:49 +02:00
Andreas Hocevar 0dafe6adbd Remove unused fonts 2020-07-23 12:32:27 +02:00
jeanpierre 9616dee9f7 Update bootstrap, cleanup css, make pages more responsive 2020-07-23 12:32:27 +02:00
MoonE 353de14624 Update config/jsdoc/api/template/tmpl/navigation.tmpl
Co-authored-by: Andreas Hocevar <andreas.hocevar@gmail.com>
2020-07-17 16:17:07 +02:00
Maximilian Krög 434ac3141f Allow line breaks before slashes in apidoc navigation 2020-07-16 21:51:29 +02:00
Andreas Hocevar 5fdf50c1de No autocomplete for api search field 2020-05-29 08:51:59 +02:00
Tim Schaub 4d9975754f Mapbox vector layer 2020-05-03 16:07:27 -06:00
Maximilian Krög b07f96e558 Remove link for fullscreen event from navigation 2020-04-10 19:07:25 +02:00
Tim Schaub 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
Tim Schaub 6eccf21543 Merge pull request #10882 from MoonE/apidoc-fix-toggle-state
Apidoc - Fix toggle state when there are no hidden members
2020-04-06 10:30:17 -06:00
Maximilian Krög a7a21aab08 Fix toggle state when there are no hidden members 2020-04-05 15:23:41 +02:00
Tim Schaub 0a6468d7ae Remove plugin for @inheritDoc 2020-04-04 13:57:48 +02:00
Frederic Junod d15ec1c12c Remove all inheritDoc tags from disposeInternal functions 2020-04-03 08:10:41 +02:00
Andreas Hocevar dd44ecf185 Only document enums when they have API properties 2020-03-28 14:17:56 +01:00
Maximilian Krög 873cccc4f3 Add default exported enums to apidoc 2020-03-12 22:29:46 +01:00
Maximilian Krög f2477622c3 Remove redundant check if doclet kind is typedef 2020-03-12 22:29:34 +01:00
Maximilian Krög 058ca59233 Also correctly detect default exports without an identifier 2020-03-12 21:36:19 +01:00
Maximilian Krög 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
Maximilian Krög d28be3c160 Fix building apidoc on windows 2020-02-28 21:44:06 +01:00
Maximilian Krög e484eca1a1 Some more cleanup
No need to sort beforehand and therefore sorting can be done at last too.
Also forEach is just fine, no need for underscore.

This changes the navigation default order for modules to be after classes
when the name is the same.
2020-02-27 23:47:22 +01:00
Maximilian Krög bc8499472c Current item may be undefined
Worked fine before, but better safe than sorry.
2020-02-27 22:58:07 +01:00
Maximilian Krög 47ed2963c4 Default exported classes have same prettyname as modules 2020-02-27 22:57:55 +01:00