Commit Graph

139 Commits

Author SHA1 Message Date
Greg Spencer
10e4b04010
Switch document generation to use the snippets package (#87231)
Switch document generation to use the snippets package instead of the snippets code in the Flutter repo. In the process, some bugs in sample code analysis have been fixed, and I've fixed some more errors in the samples.

This will allow the snippets package to be developed separately from the Flutter repo, and reduce the code in the Flutter repo.

The snippets code is deleted in this PR.

I also converted some comments in the snippet templates to be regular comments instead of doc comments, because having a doc comment block before the imports causes the Dart import sorter to lose the comment. They should have been regular comments in the first place.

The snippets package resides in the assets-for-api-docs repo.

The sample analysis has also been converted to be run in parallel, and I've bumped the Dartdoc version to 1.0.2.
2021-08-11 19:48:29 -07:00
Janice Collins
0825f49ed4
Update dartdoc to 1.0.0 (#85549)
This includes some major internal changes that should improve performance (the AOT template compiler) and the new lookup code. The big changes noticeable for Flutter will be resolution of field formal parameters, extension method support, and more consistent disambiguation in comment reference lookups.

While a vast net improvement, this PR will change a few links to point to the wrong place. #85484 will address that after this lands, as there was no good way to specify what the user wanted unambiguously before dartdoc 1.0.0 in a few cases. That PR includes more details on the introduced regressions and link changes.
2021-06-29 14:19:19 -07:00
Janice Collins
e6f2e2a38d
Update dartdoc to 0.45.0 (#84130) 2021-06-07 12:29:05 -07:00
Janice Collins
c5bbe7552a
Update dartdoc to 0.44.0. (#83352) 2021-05-25 13:04:02 -07:00
Janice Collins
cb57480bdd
Update dartdoc to 0.43.0. (#82362) 2021-05-18 08:54:02 -07:00
Janice Collins
82551118b8
Update dartdoc to 0.42.0 (#79795) 2021-04-05 14:09:03 -07:00
Janice Collins
4d062996d3
Update dartdoc to 0.41.0 (#79304) 2021-03-29 21:34:02 -07:00
Janice Collins
b300efcd8f
Update dartdoc to 0.40.0. (#76820) 2021-02-25 15:06:04 -08:00
Janice Collins
d1f78b48ea
Update dartdoc to 0.38.0 (#71935) 2020-12-08 16:13:04 -08:00
Janice Collins
a5519dc75e
Update dartdoc to 0.37.0 (#70882) 2020-11-20 11:18:07 -08:00
Janice Collins
c2054196a7
Update dartdoc to 0.36.2 (#69693) 2020-11-03 12:08:03 -08:00
Janice Collins
dcc8ced8e4
Update to dartdoc 0.36.1 (#68791) 2020-10-22 14:13:50 -07:00
Janice Collins
4a59ee9c31
Updated dartdoc to 0.36.0 (#68641) 2020-10-21 08:47:02 -07:00
godofredoc
f8f6963cd1
Fix docset generation. (#67025)
* Fix docset generation.

* Remove checks to be able to test.

* More logging

* More logging

* More logging.

* more logging.

* More logging.

* Add flags to firebase command.

* Re-enable docset generation.

* Disable firebase step.

* Comment docset to speed up validations.

* Re-enable docset.

* Add back condition to prevent uploading docs from PRs.
2020-10-13 17:06:49 -07:00
Janice Collins
e9a9a6104c
Update dartdoc to 0.35.0 (#67432) 2020-10-07 08:47:05 -07:00
Michael Goderbauer
923eb765f0
Bump dartdoc to 0.34.0 (#66048) 2020-09-22 12:57:13 -07:00
Christopher Fujino
d6e308c578
Don't fail docs-linux on release branches (#64203) 2020-08-19 18:16:05 -07:00
Michael Goderbauer
3e867f78db
Fix assert in dartdoc_checker and enable asserts (#64111) 2020-08-18 19:11:05 -07:00
Michael Goderbauer
e1a09622df
Bump dartdoc to 0.30.4 (#64112) 2020-08-18 17:31:04 -07:00
Michael Goderbauer
e49a57660d
Bump dartdoc to 0.32.3 and tighten doc quality checker (#63111) 2020-08-07 20:41:04 -07:00
Ian Hickson
209e3e9fd6
Update docs.sh (#62814) 2020-08-05 19:21:08 -07:00
Todd Volkert
8c5c720ce6
Temporarily disable docset generation (#62386)
https://github.com/flutter/flutter/issues/60646
2020-07-28 01:07:42 -07:00
Todd Volkert
39fa00201d
Use in-memory disk for docs shards (#62373)
https://github.com/flutter/flutter/issues/60646
2020-07-27 21:11:43 -07:00
Todd Volkert
271b8dd674
Fix doc generation scripts (#62340) 2020-07-27 08:46:57 -07:00
Todd Volkert
8e0eee9008
Sub-shard the docs shard (#62281)
Separate out offline docs, docset generation, and docs deployment
each into dedicated shards.

https://github.com/flutter/flutter/issues/60646
2020-07-26 23:38:01 -07:00
Todd Volkert
35e7005184
Rather than timing out dashing, run it in background (#62251)
https://github.com/flutter/flutter/issues/60646
2020-07-25 09:44:17 -07:00
Todd Volkert
5a290fc84d
Add --disable-dart-dev to docs.sh (#62249)
https://github.com/flutter/flutter/issues/62206
2020-07-24 23:51:41 -07:00
Todd Volkert
81bf39e4a9
Print date/time for each step taken in docs.sh (#62248)
This will allow us to see in the logs how long each step takes
2020-07-24 22:38:17 -07:00
Christopher Fujino
e3ad0345ba
add a timeout to dashing (#60723) 2020-07-01 19:41:41 -07:00
Janice Collins
d2572c8fb7
Update dartdoc version to 0.31.0 (#55335) 2020-04-21 19:33:02 -07:00
Janice Collins
4acc2183d9
Update dartdoc to 0.30.4. (#54894) 2020-04-15 14:20:01 -07:00
Janice Collins
601c8dbebb
Update dartdoc to 0.30.2 (#52022) 2020-03-19 14:56:03 -07:00
Greg Spencer
d8a2169741
Revert "Upgrade dartdoc to 0.30.1 (#50980)" (#51060)
This reverts commit a51de38a20 because it breaks the flutter docs.
2020-02-19 09:55:32 -08:00
Janice Collins
a51de38a20
Upgrade dartdoc to 0.30.1 (#50980) 2020-02-18 12:40:10 -08:00
Dan Field
24f39d40a4 Revert "Revert "Add many more global analyses. (#47875)" (#48080)" (#48081)
This reverts commit 04ea3183ce.
2020-01-02 11:47:28 -08:00
Francisco Magdaleno
04ea3183ce
Revert "Add many more global analyses. (#47875)" (#48080)
This reverts commit e768c92fbc.
2020-01-02 09:25:59 -08:00
Ian Hickson
e768c92fbc
Add many more global analyses. (#47875)
* Update packages.

* Add many more global analyses.

* Catch trailing spaces and trailing newlines in all text files.
  Before we were only checking newly added files, but that means we
  missed some.

* Port the trailing spaces logic to work on Windows too.

* Correct all the files with trailing spaces and newlines.

* Refactor some of the dev/bots logic into a utils.dart library.
  Notably, the "exit" and "print" shims for testing are now usable
  from test.dart, analyze.dart, and run_command.dart.

* Add an "exitWithError" function that prints the red lines and
  then exits. This is the preferred way to exit from test.dart,
  analyze.dart, and run_command.dart.

* More consistency in the output of analyze.dart.

* Refactor analyze.dart to use the _allFiles file enumerating logic
  more widely.

* Add some double-checking logic to the _allFiles logic to catch
  cases where changes to that logic end up catching fewer files
  than expected (helps prevent future false positives).

* Add a check to prevent new binary files from being added to
  the repository. Grandfather in the binaries that we've already
  added.

* Update all the dependencies (needed because we now import crypto in
  dev/bots/analyze.dart).
2019-12-30 17:12:19 -08:00
Janice Collins
bd25f70c66
Upgrade dartdoc to 0.29.3. (#47246) 2019-12-19 09:45:02 -08:00
Janice Collins
50c8e6b2d6
Update dartdoc to 0.29.2. (#46014) 2019-12-04 09:59:16 -08:00
Ian Hickson
449f4a6673
License update (#45373)
* Update project.pbxproj files to say Flutter rather than Chromium

Also, the templates now have an empty organization so that we don't cause people to give their apps a Flutter copyright.

* Update the copyright notice checker to require a standard notice on all files

* Update copyrights on Dart files. (This was a mechanical commit.)

* Fix weird license headers on Dart files that deviate from our conventions; relicense Shrine.

Some were already marked "The Flutter Authors", not clear why. Their
dates have been normalized. Some were missing the blank line after the
license. Some were randomly different in trivial ways for no apparent
reason (e.g. missing the trailing period).

* Clean up the copyrights in non-Dart files. (Manual edits.)

Also, make sure templates don't have copyrights.

* Fix some more ORGANIZATIONNAMEs
2019-11-27 15:04:02 -08:00
Janice Collins
cf08a995f6
Update dartdoc to 0.29.1 (#44466) 2019-11-11 13:23:05 -08:00
Collin Jackson
03ac37af08
Re-enable docs uploading (#44454)
* Revert "Turn off docs upload temporarily (#44365) (#44413)"

This reverts commit 8f2ea9d0e9.

* Re enables docs upload
2019-11-08 12:47:26 -08:00
Jenn Magder
8f2ea9d0e9
Turn off docs upload temporarily (#44365) (#44413) 2019-11-07 19:16:04 -08:00
Collin Jackson
62b7ce306d
Revert "Turn off docs upload temporarily (#44365)" (#44371)
* Revert "Turn off docs upload temporarily (#44365)"

This reverts commit 3dd6741078.

* show contents of firebase-debug.log
2019-11-07 15:21:45 -08:00
Greg Spencer
3dd6741078
Turn off docs upload temporarily (#44365)
Turning off Docs upload temporarily until Firebase outage is over.
Landing on red to fix the build.
2019-11-07 11:29:49 -08:00
Janice Collins
f3a6b0da92
Upgrade dartdoc to 0.29.0 (#43990) 2019-11-01 11:17:01 -07:00
Janice Collins
13a054f76e
Update dartdoc to 0.28.8 (#42686) 2019-10-15 12:32:10 -07:00
Janice Collins
4dcf1ab828
Update dartdoc to 0.28.7 (#42136) 2019-10-11 08:47:12 -07:00
Keerti Parthasarathy
0ed3242a63
Update dartdoc to 0.28.5 (#39581) 2019-09-03 09:26:14 -06:00
Keerti Parthasarathy
f3674ccfd7
Update dartdoc to 28.4 (#37314) 2019-07-31 13:41:27 -07:00