Commit Graph

26 Commits

Author SHA1 Message Date
Pavel Feldman
76abb3a5be
chore: unify tab generation (#14802) 2022-06-10 17:34:31 -07:00
Dmitry Gozman
20dcc45afa
feat: support experimental doc entries (#13446)
feat: support experimental doc entries

- Params/options/members are marked as experimental in the docs.
- `experimental.d.ts` is generated that contains all types and
  includes experimental features.
- `experimental.d.ts` is references in our tests so that we
  can test experimental features.
- `fonts` option is restored as experimental.
2022-04-13 16:13:30 -07:00
Dmitry Gozman
cef476b89f
docs: support optional methods (#13415)
So far, these are used in `Reporter`.
2022-04-07 18:51:05 -07:00
Yury Semikhatsky
79c8746fd2
docs: add name for screenshot animations option (#12601) 2022-03-08 16:02:31 -08:00
Yury Semikhatsky
ade2171c4b
fix(docs): APIRequest* variable names (#9621) 2021-10-19 09:37:17 -07:00
Dmitry Gozman
bb5e44fbc4
docs: introduce overloads, generate JSDoc for overloads (#8485)
- Each overload, e.g. for `page.evaluate`, shows a nice autocomplete doc,
  not only the first one.
- We can have multiple overloads directly on the docs page, e.g.
  `test.skip(title, fn)` and `test.skip(condition, description)`.
  These overloads are internally named `Test.skip#1` and all aliased
  to `test.skip`.
2021-08-27 21:57:40 -07:00
Dmitry Gozman
8f1074c76e
docs(test-runner): initial API docs for test runner (#7732) 2021-07-22 11:01:18 -07:00
Max Schmitt
36c5395d2d
chore: rebase documentation and markdown classes from docs (#7172) 2021-06-17 08:19:24 +02:00
Max Schmitt
1b771ed360
docs(python): add Error base class (#6315) 2021-04-28 10:41:46 +02:00
Darío Kondratiuk
e82b546085
docs(dotnet): generate arguments in a consistent order (#5800) 2021-04-08 14:21:10 +02:00
Pavel Feldman
c4410d3f4d Revert "chore(docs): add support for language specific notes (#5810)"
This bubbled up in Python comments.
2021-03-18 13:50:17 -07:00
Anže Vodovnik
693e5699ac
chore(docs): add support for language specific notes (#5810) 2021-03-17 15:20:37 +01:00
Yury Semikhatsky
ea9485ec9a
docs: document PlaywrightException in java (#5743) 2021-03-05 15:32:33 -08:00
Dmitry Gozman
c12374ea07
feat(docs): improve link validation (#5394) 2021-02-10 07:13:14 -08:00
Yury Semikhatsky
a1b3164864
docs: fix nested union handling (#5341) 2021-02-05 16:32:13 -08:00
Yury Semikhatsky
4b74f5693c
docs: add enum aliases (#5335) 2021-02-05 15:28:48 -08:00
Anže Vodovnik
cf96b15051
fix(docs): ignore case when validating order of events and methods (#5309) 2021-02-04 19:19:38 +01:00
Yury Semikhatsky
a1d875ed97
docs: make inline refs us parameter name instead of its alias (#5219) 2021-01-29 16:02:17 -08:00
Yury Semikhatsky
21041bc331
docs: support argument overrides (#5200) 2021-01-28 17:51:41 -08:00
Anže Vodovnik
f2ef7f51b8
Link patching now picks up multiple in single line (#5163) 2021-01-27 16:21:27 -08:00
Pavel Feldman
41e394bc22
docs: allow overriding return types (#5031) 2021-01-15 16:01:41 -08:00
Pavel Feldman
cac119f3bf
docs: python api review (#4986) 2021-01-12 12:14:27 -08:00
Pavel Feldman
e67d89747a
chore: update docs to cover python specifics (#4960) 2021-01-10 18:18:35 -08:00
Pavel Feldman
114d586f07
chore: add python aliases (#4949) 2021-01-08 15:00:14 -08:00
Pavel Feldman
15c0a29526
docs: split nodejs and python links (#4942) 2021-01-07 23:37:53 -08:00
Pavel Feldman
e56832b646
chore: language-specific members api (#4936) 2021-01-07 15:00:04 -08:00