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
32238806a6
Merge pull request #10617 from MoonE/apidoc-performance
...
Improve apidoc generation performance
2020-02-13 11:03:02 +01:00
4e1ca0a986
More reliable check for module content beyond classes
2020-02-13 10:41:52 +01:00
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
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
c0f058f5cf
Variable should be reset on each loop but wasn't
...
The ancestors variable is always set once the first augmented doclet is found.
The incompleteDoclet variable is also not reset between loops.
2020-02-07 00:08:14 +01:00
2e4f989d7b
Store api members as object map instead of array.
2020-02-07 00:08:14 +01:00
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
f8f7f83be7
Do not expose static render function of controls
2020-01-29 20:21:08 +01:00
e3f9e250ab
Sort doc navigation properly and add missing modules
2020-01-29 14:04:52 +01:00
afba861ab5
Merge pull request #10543 from MoonE/jsdoc-api-mustnothavevalue
...
@api tag must not have a value.
2020-01-20 09:33:28 +01:00
e2dc67546e
Only generate module apidoc pages when it contains api tags
2020-01-19 15:51:48 +01:00
9cc7ef4b96
Use correct config for tags which must not have a value.
2020-01-18 20:15:10 +01:00
9622a8ca93
Fix link in apidocs to ObjectEvent.
2019-12-27 23:35:19 +01:00
76333f72ba
Merge pull request #10204 from tschaub/doc-layout
...
Avoid scrolling over navigation
2019-10-27 17:05:39 -06:00
0f87df0ade
Add the default to the type column
2019-10-26 17:27:04 -06:00
1c21853269
Avoid scrolling over navigation
2019-10-26 16:56:14 -06:00
27cbbaf97b
Less jumpy
2019-10-26 12:30:38 -06:00
c0831cc64b
Carbon add on API docs
2019-10-26 11:11:04 -06:00
10379920d2
Avoid toggling when clicking the title
2019-10-23 10:26:21 -06:00
4fe16d0281
Tidy up navigation
2019-10-23 13:26:56 +02:00
3cb0aae796
Removes modulelink
2019-10-08 10:12:29 +02:00
490bef8d40
Readds modules without classes to navigation
2019-10-08 10:12:12 +02:00
5786121cd5
Adapts linktext to module
2019-10-07 09:50:14 +02:00
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
b045e4ee5b
Removes unused *.less files
2019-09-27 17:19:19 +02:00
3eaeef9b93
Fix link to map default controls
2019-09-26 18:31:24 +02:00
b6bd35c15c
Fix observable properties documentation
2019-07-14 10:15:00 +02:00
8d793ad6ec
List complete classes in doc navigation
2019-06-17 13:10:02 +02:00
d059689856
Index classes under modulues
2019-06-17 08:15:49 +02:00
4ea28333f8
Avoid duplicates in api docs
2019-06-17 08:15:17 +02:00
c97a728531
Merge pull request #9394 from KaiVolland/docs-import-functions
...
Introduces import snippets for static functions
2019-06-05 22:20:15 +02:00
49a9f21388
Upgrade jsdoc to v3.6.1
2019-05-05 21:29:19 +02:00
b3e770226f
Smaller scope
2019-04-28 16:03:54 -06:00
981328576f
Remove unused classes lookup
2019-04-28 16:00:43 -06:00
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
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
56a60631bc
Allow users to opt out of tracking
2019-01-02 07:36:25 +01:00
b50749e1ea
Use jsdoc-plugin-typescript
2018-10-29 19:15:01 +01:00
ba20c6333b
Move convert-types plugin to place for common use
2018-10-25 21:49:02 +02:00
453a723005
Improve link handling in API docs
2018-10-24 17:52:42 +02:00
3a42a0859c
Fix event documentation
2018-10-23 18:05:43 +02:00
0593c352af
Avoid duplicate documentation
2018-10-23 18:05:26 +02:00
724d141d3a
Fix links and navigation
2018-10-23 18:05:02 +02:00
deb6c093a8
Update plugin chain to support JSDoc import types
2018-10-23 18:04:26 +02:00
0b21d1a6fc
Document anonymous default exports
2018-10-23 18:01:46 +02:00
cd2f0f60d6
Make link texts consistent with docs
2018-10-23 17:40:51 +02:00
d12ef20b12
Use Array<Foo> instead of Array.<Foo>
2018-07-25 18:32:43 -07:00
d8b290966b
Tracking
2018-07-21 09:11:30 -06:00
b8c9125602
Remove lint
2018-07-18 10:35:54 -06:00
Andreas Hocevar
Maximilian Krög
Tim Schaub
Tim Schaub
Kai Volland
Marc Jansen