Commit Graph

84 Commits

Author SHA1 Message Date
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 d3b9b25429 Search if the search input is not empty after page loads
Firefox remembers input on the same page if a normal reload is performed.
In this case the results for the search term should be shown automatically.
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
Maximilian Krög b9455bfad9 Remove unnecessary / duplicate code. 2020-02-21 22:55:31 +01:00
Maximilian Krög 2b8582fcad Catch errors when search term is an invalid regular expression
On error search escape special characters, with only '.' matching
any characters.
2020-02-21 22:50:57 +01:00
Maximilian Krög d56513b722 Add code to measure search function speed 2020-02-21 22:50:57 +01:00
Maximilian Krög 99ecce2a87 Provide the searchTerm as argument to doSearch function 2020-02-21 22:50:57 +01:00
Maximilian Krög b919074aa3 Skip searches when typing fast / slow cpu. 2020-02-21 22:50:57 +01:00
Maximilian Krög 6187118166 Hide member-lists, show current item when clearing input 2020-02-21 22:50:57 +01:00
Maximilian Krög f5a996a64e Highlight current anchor with css instead of js.
The `:target` selector is supported by all browsers.
2020-02-21 22:50:57 +01:00
Andreas Hocevar 8750cb0b1a Merge pull request #10653 from ahocevar/apidoc-nav
More reliable check for module content beyond classes
2020-02-13 14:30:26 +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
Andreas Hocevar 4e1ca0a986 More reliable check for module content beyond classes 2020-02-13 10:41:52 +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
Andreas Hocevar f8f7f83be7 Do not expose static render function of controls 2020-01-29 20:21:08 +01:00
Andreas Hocevar e3f9e250ab Sort doc navigation properly and add missing modules 2020-01-29 14:04:52 +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 490bef8d40 Readds modules without classes to navigation 2019-10-08 10:12:12 +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
Kai Volland b045e4ee5b Removes unused *.less files 2019-09-27 17:19:19 +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 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