ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
27,223 Commits 5 Branches 232 Tags
b613e8e77fa7100c43944a61d2bd79ea10a8e8a9
Commit Graph

54 Commits

Author SHA1 Message Date
Maximilian Krög
1b4ed08bc5 Indent line-wrapped class names 2020-02-21 22:55:32 +01:00
Maximilian Krög
cc561dab8e Allow word wrap before '.' and '~' in class names 2020-02-21 22:55:32 +01:00
Maximilian Krög
7640bcd163 Only match the displayed name of items when searching 
Currently the search term is matched against the longname of members.
Because of this most members are matched when searching for a
class / module and also searching for 'mod' matches everything as
all longnames start with 'module:'
 2020-02-21 22:55:32 +01:00
Maximilian Krög
f7871d6103 Store search data in lowercase and compare in lowercase 
This way we can do the search case-sensitive after only converting
the search term to lowercase.
 2020-02-21 22:55:32 +01:00
Andreas Hocevar
32238806a6 Merge pull request #10617 from MoonE/apidoc-performance 
Improve apidoc generation performance
 2020-02-13 11:03:02 +01:00
Maximilian Krög
300cc282e4 Generate valid html for the apidoc navigation 
Only `<li>` can be a direct descendant of `<ul>` tags.
 2020-02-10 00:10:05 +01:00
Maximilian Krög
5d922fc53b Cleanup navigation.tmpl and the generated html 
- Add a function that is used to generate all four types of member lists.
- Only use one line per list item.
- Don't generate empty `class=""` attributes when item is stable.
- Remove closing `</li>` tag, as is allowed by the html 5 standard.

Overall this reduces the filesize for the generated html pages by ~33%.
 2020-02-10 00:09:33 +01:00
Maximilian Krög
0c04293d5f Generate navigation html only once for all pages. 
This reduces the time for apidoc generation by ~30%.
 2020-02-07 00:08:07 +01:00
Maximilian Krög
9622a8ca93 Fix link in apidocs to ObjectEvent. 2019-12-27 23:35:19 +01:00
Tim Schaub
76333f72ba Merge pull request #10204 from tschaub/doc-layout 
Avoid scrolling over navigation
 2019-10-27 17:05:39 -06:00
Tim Schaub
0f87df0ade Add the default to the type column 2019-10-26 17:27:04 -06:00
Tim Schaub
1c21853269 Avoid scrolling over navigation 2019-10-26 16:56:14 -06:00
Tim Schaub
27cbbaf97b Less jumpy 2019-10-26 12:30:38 -06:00
Tim Schaub
c0831cc64b Carbon add on API docs 2019-10-26 11:11:04 -06:00
Tim Schaub
10379920d2 Avoid toggling when clicking the title 2019-10-23 10:26:21 -06:00
Andreas Hocevar
4fe16d0281 Tidy up navigation 2019-10-23 13:26:56 +02:00
Kai Volland
3cb0aae796 Removes modulelink 2019-10-08 10:12:29 +02:00
Kai Volland
5786121cd5 Adapts linktext to module 2019-10-07 09:50:14 +02:00
Kai Volland
d08c0baff9 Introduces apidoc changes 
- Removes modules from the apidoc navigation
- Adds a weight paramater to the search to be
more accurate on searchresults
 2019-09-27 17:25:01 +02:00
ahocevar
8d793ad6ec List complete classes in doc navigation 2019-06-17 13:10:02 +02:00
ahocevar
d059689856 Index classes under modulues 2019-06-17 08:15:49 +02:00
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
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
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
d8b290966b Tracking 2018-07-21 09:11:30 -06: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
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
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
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
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
d27ea0974e Fix source links, display version and warn about outdated docs 2016-05-11 12:45:58 +02: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
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
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