89d769765a
Revert "[tools] verify_docs don't error on library annotations"
...
This reverts commit 97eaded1edhttps://github.com/dart-lang/sdk/issues/50291#issuecomment-1290158070
Original change's description:
> [tools] `verify_docs` don't error on library annotations
>
> Dartdoc code snippets should be able to have annotations before the
> `library` keyword.
>
> Bug: https://github.com/dart-lang/sdk/issues/49803#issuecomment-1287044157
>
> Change-Id: I7ec0b6db296274a1173d10d900f7af38a1f2b552
> Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/265321
> Reviewed-by: Devon Carew <devoncarew@google.com >
> Auto-Submit: Daco Harkes <dacoharkes@google.com >
> Commit-Queue: Daco Harkes <dacoharkes@google.com >
> Commit-Queue: Devon Carew <devoncarew@google.com >
TBR=lrn@google.com ,devoncarew@google.com ,dacoharkes@google.com ,dart-scoped@luci-project-accounts.iam.gserviceaccount.com
Change-Id: I379a1871a1acd4d1c66804c3948f38e45691fd55
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Bug: https://github.com/dart-lang/sdk/issues/49803#issuecomment-1287044157
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/265324
Commit-Queue: Daco Harkes <dacoharkes@google.com >
Bot-Commit: Rubber Stamper <rubber-stamper@appspot.gserviceaccount.com >
Reviewed-by: Alexander Thomas <athom@google.com >
2022-10-25 09:35:18 +00:00
97eaded1ed
[tools] verify_docs don't error on library annotations
...
Dartdoc code snippets should be able to have annotations before the
`library` keyword.
Bug: https://github.com/dart-lang/sdk/issues/49803#issuecomment-1287044157
Change-Id: I7ec0b6db296274a1173d10d900f7af38a1f2b552
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/265321
Reviewed-by: Devon Carew <devoncarew@google.com >
Auto-Submit: Daco Harkes <dacoharkes@google.com >
Commit-Queue: Daco Harkes <dacoharkes@google.com >
Commit-Queue: Devon Carew <devoncarew@google.com >
2022-10-24 18:01:55 +00:00
f7c46f145c
[pkg] prefer 'any' deps for package dev dependencies
...
Tested: CI validation
Change-Id: If65cc156130a65ffe00c6f1660ac320e2921afae
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/246053
Commit-Queue: Devon Carew <devoncarew@google.com >
Reviewed-by: Nate Bosch <nbosch@google.com >
2022-05-27 01:34:59 +00:00
c4dc032f6c
[repo] improve the analysis of the tools/ directory
...
Change-Id: I4185e3bdc1f0f6f8464ebc2a043254200e3df486
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/233502
Reviewed-by: Samuel Rawlins <srawlins@google.com >
Commit-Queue: Devon Carew <devoncarew@google.com >
2022-02-17 19:09:52 +00:00
225b8d3f58
Make expression-detection in doc verifier more discriminating.
...
The existing behavior treated `var x = e; // comment` as an expression,
and failed spectacularly to insert it after a `return`.
The new behavior detects a `;` anywhere in the single line, not just
at the end, as a sign that a single line is probably not an expression.
Change-Id: Ice5abc8dc802db36511dc3cdcca162dc0e8a8f13
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/229155
Auto-Submit: Lasse Nielsen <lrn@google.com >
Reviewed-by: Devon Carew <devoncarew@google.com >
Commit-Queue: Lasse Nielsen <lrn@google.com >
2022-01-24 11:12:18 +00:00
44baaf13b6
Allow code samples to *continue* a prior sample.
...
We have added more examples, and some of them uses the structure of:
````dart
/// ```dart
/// var x = something;
/// ```
/// and then you can also floo the thing
/// ```
/// x.floo(...);
/// ```
````
The following chunks of the same example can now be written as:
````dart
/// ```dart continued
/// x.floo(...);
/// ```
````
Change handling of imports,
and introduce a `top` template different from `none`.
The `none` template gets nothing for free.
The sample must be completely self-contained.
Is triggered by the sample containing a `library` declaration,
because we can't add anything before that.
The `top` template allows top-level declarations,
but does introduce automatic imports and "samples can expect"
code if the sample doesn't contain `import`s.
Is triggered by top-level declarations other than `library`.
Also some restructuring of the code to make this feature easier
to implement.
Change-Id: If2288147face01efad2ad656aa52183cb4c8b3bf
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/221343
Commit-Queue: Lasse Nielsen <lrn@google.com >
Reviewed-by: Devon Carew <devoncarew@google.com >
2021-12-02 16:37:57 +00:00
5811541df6
tools/verify_docs: refactor error cleanup, add _http special-cases
...
Change-Id: I06e91d1bac5f5a512a3a74f0e2665c1989ecf36f
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/218663
Auto-Submit: Kevin Moore <kevmoo@google.com >
Commit-Queue: Kevin Moore <kevmoo@google.com >
Commit-Queue: Devon Carew <devoncarew@google.com >
Reviewed-by: Devon Carew <devoncarew@google.com >
2021-10-29 18:01:20 +00:00
b27c191c2a
Add the dart: api doc code sample validation to the CI.
...
Change-Id: Ib2a97728d35d15e6cda247444a00ca813d88b9d3
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/218325
Reviewed-by: Michael Thomsen <mit@google.com >
Commit-Queue: Devon Carew <devoncarew@google.com >
2021-10-28 15:48:38 +00:00
840a8aada4
[core libs] add the ability to have sample assumptions when validating the api docs
...
Change-Id: Ic2d0af4dd033b09fb5b0fcf4f57a48da367b6f1d
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/216681
Commit-Queue: Devon Carew <devoncarew@google.com >
Reviewed-by: Kevin Moore <kevmoo@google.com >
2021-10-18 16:11:48 +00:00
1e1c730140
[api docs] speed up API doc validation
...
Change-Id: Ieb4f8f8a406f28afb6e43c10727aa74a194e9b8c
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/216686
Commit-Queue: Devon Carew <devoncarew@google.com >
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
2021-10-13 22:53:07 +00:00
a1e2432679
support specifying templates when verifying docs
...
Change-Id: I76800141e8bac1b0c3953ec6012ee84c192070ef
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/215280
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
Commit-Queue: Devon Carew <devoncarew@google.com >
2021-10-07 16:45:43 +00:00
bafa71a8ae
Add the ability to specify additional imports for doc samples.
...
Change-Id: I1c9592d4ce66d08aafacd5ae9722defa114c9953
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/214867
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
Commit-Queue: Devon Carew <devoncarew@google.com >
2021-09-30 16:35:59 +00:00
1d43ec2a99
Add an initial version of a script to validate the code samples in the dart: doc comments.
...
Change-Id: If74a11ffee8130963c37c9bd8ad74da4211f61d7
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/214307
Commit-Queue: Devon Carew <devoncarew@google.com >
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
2021-09-26 03:07:11 +00:00
Daco Harkes