Commit Graph

49 Commits

Author SHA1 Message Date
ahocevar b50749e1ea Use jsdoc-plugin-typescript 2018-10-29 19:15:01 +01:00
ahocevar 453a723005 Improve link handling in API docs 2018-10-24 17:52:42 +02:00
ahocevar 724d141d3a Fix links and navigation 2018-10-23 18:05:02 +02:00
ahocevar 0b21d1a6fc Document anonymous default exports 2018-10-23 18:01:46 +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
ahocevar 527331a797 Make docs work when published 2018-05-13 11:15:31 -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
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
Andreas Hocevar 86d0074386 Print ES6 import hint on each doc page 2017-08-15 19:17:06 -04: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 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
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 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
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
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
Tim Schaub 6dc7f2cfec Remove footer with timestamp 2015-08-07 11:22:07 -06: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 05c1e973a3 Merge pull request #3415 from malaretv/stable-only-off
Stable Only unchecked by default.
2015-04-03 20:08:16 +02:00
Petr Pridal f47009447b Retina ol logo 35px (70px) for the JSDOC template 2015-04-02 08:43:26 +02:00
Petr Pridal 4427d0ba42 Updated menu on the JSDOC template (non-responsive) 2015-04-01 19:42:57 +02:00
vmalaret 4daf08ec1d Rename flag to 'stableonly' 2015-04-01 09:26:17 +02:00
vmalaret 3576f8b793 Stable Only unchecked by default in docs.
Having it on by default makes it difficult
for new users to find commonly used functionality.
2015-03-30 10:37:50 +02:00
Andreas Hocevar 4862a8c897 Create github source links 2015-03-23 16:08:36 +01:00
Andreas Hocevar 4714c9b380 Fix typo in selector 2014-11-18 16:37:18 +01:00
Tim Schaub 39010238b9 Make stability checkbox sticky 2014-11-11 20:06:26 -08:00
Tim Schaub d4658837e2 Use toggleClass instead of addClass and removeClass 2014-11-06 10:42:40 -07:00
Andreas Hocevar 1d221f8166 Add ability to filter out unstable Fires items 2014-11-06 10:32:17 -07:00
Tim Schaub 02bfa42736 List events fired in the navigation 2014-11-03 16:52:17 -07:00
Tim Schaub 61d759acc7 Add unstable class to typedefs in navigation menu 2014-08-24 18:35:18 -06:00
Tim Schaub 79efcc78a5 Add unstable class to member definitions 2014-08-24 18:31:23 -06:00
Tim Schaub a8999f601b Hide unstable items by default, provide checkbox for toggling 2014-08-22 17:30:29 -06:00
Tim Schaub ecaedff890 Add "unstable" class to unstable items
This also removes the events from the sidebar.  These are repeated on the main page and only add unnecessary length to the sidebar.
2014-08-22 17:28:50 -06:00
Tim Schaub f17c33f631 Rename buildcfg to config 2014-08-22 07:28:05 -06:00