- 20 Nov, 2023 1 commit
-
-
Sam Rawlins authored
-
- 20 Oct, 2023 1 commit
-
-
Michael Goderbauer authored
These warnings/errors have been removed from dartdoc. Removing them from the flutter config as well. Also fixes CI to actually test doc generation for all documented packages and on dartdoc config changes.
-
- 29 Aug, 2023 1 commit
-
-
Greg Spencer authored
-
- 17 Aug, 2023 1 commit
-
-
Greg Spencer authored
## Description This re-lands #132353 with some additional options for keeping around the staging directory, so that the recipe for publishing docs can give those options and have the staging directory left around for deploying to the website. Reverted in #132613 ## Related Issues - https://flutter-review.googlesource.com/c/recipes/+/49580
-
- 16 Aug, 2023 1 commit
-
-
Jonah Williams authored
Reverts flutter/flutter#132353 Educated guess that this is causing the docs failures: https://logs.chromium.org/logs/flutter/buildbucket/cr-buildbucket/8772644466113801713/+/u/Docs/Deploy_docs/Firebase_deploy/stdout
-
- 15 Aug, 2023 1 commit
-
-
Greg Spencer authored
## Description This cleans up a lot of issues with the API doc generation. Here are the main changes: - Rename `dartdoc.dart` to `create_api_docs.dart` - Move the bulk of the operations out of `dev/bots/docs.sh` into `create_api_docs.dart`. - Delete `dashing_postprocess.dart` and `java_and_objc.dart` and incorporate those operations into `create_api_docs.dart`. - Refactor the doc generation into more understandable classes - Bump the snippets tool version to 0.4.0 (the latest one) - Centralize the information gathering about the Flutter repo into the new `FlutterInformation` class. - Clean up the directory handling, and convert to using the `file` package for all file and directory paths. - Add an `--output` option to docs.sh that specifies the location of the output ZIP file containing the docs. - Defaults to placing the output in `dev/docs/api_docs.zip` (i.e. where the previous code generates the file). - Moved all document generation into a temporary folder that is removed once the documents are generated, to avoid VSCode and other IDEs trying to index the thousands of HTML and JS files in the docs output. - Updated pubspec dependencies. ## Tests - Added tests for doc generation.
-
- 08 Jun, 2023 1 commit
-
-
Janice Collins authored
This updates dartdoc to 6.3.0. Release notes are available, here: https://github.com/dart-lang/dartdoc/releases/tag/v6.3.0 Most important for Flutter are the reduction in the size of generated HTML files (dart-lang/dartdoc#3384) and a new dartdoc directive to hide constant implementations from indicated classes (dart-lang/dartdoc#3398), which fixes the longstanding issue (dart-lang/dartdoc#2657). I've also added the api documentation zip to `.gitignore` and the `{@hideConstantImplementations}` dartdoc directive to the motivating example. A screenshot: ![Screenshot 2023-06-07 at 9 54 58 AM](https://github.com/flutter/flutter/assets/14116827/1ad9c1f0-b224-462f-a8e3-706d9858f0d8) I assert that this change to icons.dart should be test-exempt as existing tests cover whether or not dartdoc directives are recognized or are leaking into HTML, and the impact of adding the directive was tested in dart-lang/dartdoc#3398.
-
- 26 May, 2023 1 commit
-
-
Greg Spencer authored
## Description Bumps the version for snippets to the latest version. ## Related Issues - https://github.com/flutter/flutter/issues/127320 ## Tests - No test changes needed.
-
- 27 Apr, 2023 1 commit
-
-
Janice Collins authored
This PR updates the dartdoc version to v6.2.2. Release notes: https://github.com/dart-lang/dartdoc/releases/tag/v6.2.2 The main impact for Flutter is to update dartdoc to add chips to class and/or mixin pages for class modifiers. See dart-lang/dartdoc#3391, dart-lang/dartdoc#3402. This will also be a cherry-pick candidate for 3.1 if it can land in time. - [ test-exempt ] I added new tests to check the change I am making, or this PR is [test-exempt].
-
- 24 Mar, 2023 1 commit
-
-
Janice Collins authored
Update dartdoc to 6.2.1.
-
- 22 Mar, 2023 1 commit
-
-
Michael Goderbauer authored
Update dartdoc to 6.2.0
-
- 17 Feb, 2023 1 commit
-
-
Ian Hickson authored
* lerp documentation * Remove Note, Note That from repo * Improve BorderSide documentation. * apply review comments
-
- 16 Dec, 2022 1 commit
-
-
Drew Roen authored
-
- 13 Dec, 2022 1 commit
-
-
Greg Spencer authored
-
- 09 Dec, 2022 3 commits
-
-
Jason Simmons authored
-
Siva authored
it complains about some library being unsound.
-
Parker Lougheed authored
-
- 06 Dec, 2022 1 commit
-
-
Parker Lougheed authored
No longer generates weird constructor-like calls interspersed. Fixes https://github.com/dart-lang/dartdoc/issues/3201
-
- 02 Dec, 2022 1 commit
-
-
godofredoc authored
This is to move more logic to the repo under test and remove them from recipes. Bug: https://github.com/flutter/flutter/issues/115489
-
- 29 Sep, 2022 1 commit
-
-
Kevin Moore authored
-
- 16 Sep, 2022 1 commit
-
-
Dan Field authored
-
- 06 Jul, 2022 1 commit
-
-
Michael Goderbauer authored
-
- 19 May, 2022 1 commit
-
-
Michael Goderbauer authored
-
- 13 May, 2022 1 commit
-
-
Michael Goderbauer authored
-
- 12 May, 2022 1 commit
-
-
Michael Goderbauer authored
-
- 13 Apr, 2022 1 commit
-
-
Michael Goderbauer authored
-
- 25 Feb, 2022 1 commit
-
-
Greg Spencer authored
-
- 24 Nov, 2021 1 commit
-
-
Kevin Moore authored
-
- 26 Oct, 2021 1 commit
-
-
Janice Collins authored
-
- 04 Oct, 2021 3 commits
-
-
Janice Collins authored
-
Greg Spencer authored
This fixes an issue with the Dart Head-Head-Head CI bot, where it was seeing failures because of concurrent execution of the snippets tool. It adds a single run of the snippets tool right after activation to force the compiling of the package executable, which is what has trouble with concurrent invocation. This is a temporary measure until dart pub global run is fixed.
-
Greg Spencer authored
This does a cleanup of the examples, removing all of the "section" markers and extra comments that we don't need anymore now that the samples are no longer in the source code. It also removes the --template arguments from the {@tool dartpad} and {@tool sample} directives, since those are no longer used. It converts two examples that I discovered were still embedded into linked examples in the examples folder. I didn't delete the templates from the snippets config folder yet, because there are still embedded samples in the dart:ui package from the engine that use them. Once dart:ui no longer uses the templates, they can be removed. I bumped the version of the snippets package to pick up a change that allows removal of the --template argument.
-
- 24 Sep, 2021 1 commit
-
-
Janice Collins authored
-
- 08 Sep, 2021 1 commit
-
-
Janice Collins authored
-
- 30 Aug, 2021 1 commit
-
-
Greg Spencer authored
-
- 23 Aug, 2021 1 commit
-
-
Janice Collins authored
-
- 13 Aug, 2021 1 commit
-
-
Greg Spencer authored
-
- 12 Aug, 2021 1 commit
-
-
Greg Spencer authored
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.
-
- 29 Jun, 2021 1 commit
-
-
Janice Collins authored
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.
-
- 07 Jun, 2021 1 commit
-
-
Janice Collins authored
-