Commit graph

75 commits

Author SHA1 Message Date
Siva 7c8e171320
Manual Roll of Flutter Engine from 67254d6e4b03 to 8d83b98c55b3 (#116635)
* Roll Flutter Engine from 67254d6e4b03 to 8d83b98c55b3

* Roll Dart SDK from 35a9facce191 to e517487c5679 (Dart 3.0) (#38105)

* Bump SDK versions.

* Bump Dart SDK version constraints

* Update shrine package to 2.0.1 (null safe version)

* Fix more tests.

* Include patches from Jason for min android sdk version

* Fix analyzer warning
2022-12-08 18:03:51 -08:00
Greg Spencer 31ea315c3c
Add offline docs, up the h2 size (#116241) 2022-11-30 02:29:02 +00:00
Greg Spencer 1f0760a1cc
Fix API docs CSS files so dark mode works (#112023) 2022-09-21 18:33:08 +00:00
Pierre-Louis b9528c057a
Remove trailing spaces in repo (#101191)
* Remove trailing spaces

* more

* empty commit
2022-04-15 14:06:30 +02:00
Michael Goderbauer 195a1cc413
Prepare dev (minus flutter_gallery) for use_super_parameters (#100516) 2022-03-29 12:52:42 -07:00
Tatsuyuki Ishi 9067923d93
Remove font-weight overrides from dartdoc (#90936) 2021-12-08 10:14:05 -08:00
Kevin Moore d1cd614338
dev: Drop domain verification file (#94124) 2021-11-23 16:03:02 -08:00
Jenn Magder b8d53d51e4
Update docs to point to assets-for-api-docs cupertino css file (#92932) 2021-11-04 12:33:02 -07:00
Michael Goderbauer 811f0d9a15
"Migrate" dummy packages to null safety (#84013) 2021-06-04 22:14:03 -07:00
Pierre-Louis 5bae3b5db3
Add previews for CupertinoIcons (#71853) 2020-12-08 09:13:07 -08:00
Janice Collins e9a9a6104c
Update dartdoc to 0.35.0 (#67432) 2020-10-07 08:47:05 -07:00
Will Larche ee6d4c6590
[Docs] [Material] Fix Icons api docs (#66508)
* [Docs] [Icons] Updating dart doc styles to recognize more styles of icons. All the 4 icon styles we support have to be pulled from 4 individual web fonts when we show the html page for api docs.

* Better documentation and that special awful case.

* Couple more places to remove.
2020-09-24 15:18:10 -04:00
Michael Goderbauer 6ab558d86a
Revert "Add padding around flutter api docs search input (#44980)" (#63113)
This reverts commit c8cb245f24.
2020-08-06 16:15:09 -07:00
冷石 Boy c8cb245f24
Add padding around flutter api docs search input (#44980) 2020-07-30 09:17: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
Yazeed Al-Khalaf d41b1fbb50
✒ Spell Check All .md Files Related to Flutter 💙 (#61564)
* 🐛 Fix Spelling Issues in Main README.md

* 🐛 Fix spelling issues in dev README.md

* 🐛 Fix spelling issues in complex_layout README.md

* 🐛 Fix spelling issues in macrobenchmarks README.md

* 🐛 Fix spelling issues in platform_views_layout README.md

* 🐛 Fix spelling issues in test_Apps/stocks README.md

* 🐛 Fix spelling issues in bots README.md

* ✒ Spell Check dev/ci README.md

* ✒ Spell Check dev/ci/docker_linux README.md

* ✒ Spell Check dev/devicelab README.md

* ✒ Spell Check dev/docs README.md

* ✒ Spell Check dev/snippets README.md

* ✒ Spell Check dev/snippets/config/templates README.md

* ✒ Spell Check dev/tools/gen_keycodes README.md

* ✒ Spell Check dev/tools/vitool README.md

* ✒ Spell Check examples/catalog README.md

* ✒ Spell Check examples/flutter_view README.md

* ✒ Spell Check examples/image_list README.md

* ✒ Spell Check examples/layers README.md

* ✒ Spell Check examples/platform_channel README.md

* ✒ Spell Check examples/platform_channel_swift README.md

* ✒ Spell Check examples/platform_view README.md

* ✒ Spell Check packages/_flutter_web_build_script README.md

* ✒ Spell Check packages/flutter_localizations README.md

* ✒ Spell Check packages/flutter_tools README.md

* ✒ Spell Check CODE_OF_CONDUCT.md

* ✒ Spell Check dev/integration_test/android_splash_screens/splash_Screen_load_rotate README.md

* ✒ Spell Check dev/integration_test/android_views README.md

* ✒ Spell Check dev/integration_tests/flutter_driver_screenshot_test README.md

* ✒ Spell Check dev/integration_tests/flutter_gallery README.md

* ✒ Spell Check dev/integration_tests/gradle_deprecated_settings README.md

* ✒ Spell Check dev/integration_tests/ios_add2app_life_cycle README.md

* ✒ Spell Check dev/integration_tests/ios_host_app README.md

* ✒ Spell Check dev/integration_tests/ios_platform_view_tests README.md

* ✒ Spell Check dev/automated_tests/flutter_test README.md

* ✒ Spell Check .github/PULL_REQUEST_TEMPLATE.md

* ✒ Spell Check .hithub/ISSUE_TEMPLATE/ACTIVATION.md

* ✒ Spell Check .github/ISSUE_TEMPLATE/BUG.md

* ✒ Spell Check .github/ISSUE_TEMPLATE/feature_request.md

* ✒ Spell Check .github/ISSUE_TEMPLATE/performance_others.md

* ✒ Spell Check .github/ISSUE_TEMPLATE/performance_speed.md

* ✒ Spell Check packages/flutter_tools/doc/daemon.md

* ✒ Spell Check packages/flutter_tools/fuchsia_enrtypoint_shim/README.md

* ✒ Minimize line to 80 columns

* ✒ Minimize line to 80 columns

* ✒ Fix Typo

* ✒ Chnaged numbers to 1 for testing purposes

* ✒ Changed numbers to 1 for testing purposes

*  Remove 'a' which is a typo

* ✒ Change a sentence to be better

* ✒ Remove 'a' which is a typo

* ✒ Fix small issue

* ✒ Fix small typo

* ✒ Fix some typos

*  Remove trailing space

*  Remove trailing space

* 🐛 Fix small typo

* ✒ Fix Typo

* 🐛 Fix small bug
2020-07-22 18:23:47 -07:00
Tim Sneath 85f9d590eb
Update README.md (#56727) 2020-05-11 12:10:02 -07:00
Alexandre Ardhuin a4054938ce
unnecessary multiline strings (#50806) 2020-02-25 18:12:17 -08:00
Greg Spencer 9fb781a54a
Update samples to work with Dartpad, and convert all that make… (#50377)
This PR modifies the existing API docs samples to use DartPad so that all of the samples are now interactive apps on the API docs site.

It also removes the restriction for the max width of the description area so that the dartpad region can expand horizontally.

I updated the first paragraph on the API docs to indicate that Flutter is more than just mobile now (same text as the README.md at the top level).

I modified a few of the examples so that they looked nicer, and fit better on the page.

I added the sample description text above each DartPad instance, since that often defines the context of the example.

I removed animations and images when they were redundant with the sample content. There were a few that made sense to keep, so I did.
2020-02-10 10:00:20 -08:00
Brett Morgan b530111c5a
Update documentation URLs (#49208) 2020-01-22 09:55:09 +11: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
Ian Hickson 1ce4a4f36f
Make sure all our .dart files have license headers (#44467) 2019-11-08 16:53:21 -08:00
Andrew Brogdon 691977755c
Adds DartPad option to the DartDoc snippet generator. (#39924) 2019-09-10 08:36:14 -07:00
Andrew Brogdon 5400323648
Updates CORS origin for snippets. (#39780) 2019-09-05 16:08:48 -07:00
Andrew Brogdon aff16348e7
Adding header rule to FB hosting for API docs. (#39345) 2019-08-28 10:21:15 -07:00
Greg Spencer 67ee3e191e
Add anchors to samples (#35906)
This adds an "anchor button" to each of the samples so that the user can link to individual samples instead of having to link to just the page. Clicking on the anchor button jumps to the anchor, as well as copying the anchor URL to the clipboard.

There is some oddness in the implementation: because dartdoc uses a <base> tag, the href for the link can't just be "#id", it has to calculate the URL from the current window href. I do that in the onmouseenter and onclick because onload doesn't get triggered for <a> tags (and onmouseenter doesn't get triggered for mobile platforms), but I still want the href to be updated before someone right-clicks it to copy the URL.
2019-07-10 16:48:20 -07:00
Kate Lovett 054d9bb2f1
Updating dart.dev related links (#32641)
* Updating dart.dev related links

* Update packages/flutter_tools/lib/src/base/context.dart
2019-05-14 10:35:00 -07:00
Tim Sneath 529189791c
Replace flutter.io with flutter.dev (#30562) 2019-04-05 11:39:30 -07:00
Michael Goderbauer f0c2be3c1e
Fix links on homepage of API docs (#29641) 2019-03-20 14:42:46 -07:00
Jonah Williams 83614757be
Revert "Remove the old HaTS implementation on API docs" (#28748) 2019-03-01 15:42:43 -08:00
Ja Young Lee d1cb00bcda Remove the old HaTS implementation on API docs (#28683) 2019-03-01 14:05:16 -08:00
Jonah Williams 2acf6fdb6b
Outline for survey implementation (#27305) 2019-02-20 15:28:28 -08:00
Greg Spencer dff25a3055
Fix Dashing rules to use new dartdoc CSS entity markers. (#27818)
This fixes the offline Dash/Zeal docs generation to use the newly added dartdoc markers for different entity types to make it more exact when finding entity names.

Bumped Dartdoc to the next release.
2019-02-15 08:40:19 -08:00
Greg Spencer 262f12b4a9
Remove remaining "## Sample code" segments, and fix the snippet generator. (#27793)
This converts all remaining "## Sample code" segments into snippets, and fixes
the snippet generator to handle multiple snippets in the same dartdoc block
properly.

I also generated, compiled, and ran each of the existing application samples,
and fixed them up to be more useful and/or just run without errors.

This PR fixes these problems with examples:

1. Switching tabs in a snippet now works if there is more than one snippet in
   a single dartdoc block.
2. Generation of snippet code now works if there is more than one snippet.
3. Contrast of text and links in the code sample block has been improved to
   recommended levels.
4. Added five new snippet templates, including a "freeform" template to make
   it possible to show examples that need to change the app instantiation.
5. Fixed several examples to run properly, a couple by adding the "Scaffold"
   widget to the template, a couple by just fixing their code.
6. Fixed visual look of some of the samples when they run by placing many
   samples inside of a Scaffold.
7. In order to make it easier to run locally, changed the sample analyzer to
   remove the contents of the supplied temp directory before running, since
   having files that hang around is problematic (only a problem when running
   locally with the `--temp` argument).
8. Added a `SampleCheckerException` class, and handle sample checking
   exceptions more gracefully.
9. Deprecated the old "## Sample code" designation, and added enforcement for
   the deprecation.
10. Removed unnecessary `new` from templates (although they never appeared in
   the samples thanks to dartfmt, but still).

Fixes #26398
Fixes #27411
2019-02-15 07:48:49 -08:00
Janice Collins 6bb4b12633
Update dartdoc to 0.28.1+2 and fix search text alignment (#27559) 2019-02-06 11:10:59 -08:00
Greg Spencer 02dbb08cdc
Modify offline docs platform family for Dash/Zeal (#27053)
This changes the DocSetPlatformFamily key to be "dartlang" instead of the name of the package (usually "flutter"). This is so that the IntelliJ plugin for Dash will be able to go directly to the docs for a symbol from a keystroke, instead of needing to search all the docsets each time.

Without this, flutter isn't part of the list of package names it searches. After this, it finds the flutter docs because they're declared to be part of the "dartlang" family of docs.

Dashing doesn't have a way to configure this, so we modify the Info.plist directly to make the change.
2019-01-25 08:48:52 -08:00
Greg Spencer 625a37b86a
Adds favicon to Dash/Zeal docset, adds OpenSearch metadata. (#25178)
This sets the favicon for the offline Dash/Zeal docs.

Also, sets up the OpenSearch Description metadata file so that people can create custom search shortcuts for the API docs site.

Fixes #6412
2018-12-11 09:53:33 -08:00
Greg Spencer f827ebf357
Merge analaytics from docs site and flutter.io site. (#24825) 2018-11-28 15:37:18 -08:00
Greg Spencer f20adcc428
Add docset generation (#24322)
(re-land of #24244)

This generates a zip file containing all of the docs, and uploads it when we publish docs, as well as a
Dash/Zeal docset that contains a feed of the docs.

Addresses at least part of #9955
2018-11-15 15:05:57 -08:00
Daohan Chong ec8ca8606c Add dashing config file for generating docset from flutter docs (#24374) 2018-11-15 10:57:02 -08:00
Greg Spencer 1561815e6c
Revert "Generate a zip file of offline docs and a Dash/Zeal docset. (#24244)" (#24313)
This reverts commit f3a4f7e86d.

Accidental merge on red.
2018-11-13 16:02:34 -08:00
Greg Spencer f3a4f7e86d
Generate a zip file of offline docs and a Dash/Zeal docset. (#24244)
This generates a zip file containing all of the docs, and uploads it when we publish docs, as well as a
Dash/Zeal docset that contains a feed of the docs.

Addresses at least part of #9955
2018-11-13 15:58:06 -08:00
Todd Volkert df57dc9da9
Add content to the API doc landing page (#24193) 2018-11-11 22:36:47 -08:00
Todd Volkert 515dbcba82
Update API docs landing page. (#24073) 2018-11-08 09:00:47 -08:00
Greg Spencer 094f93dfcf
Fixes several bugs in samples, quotes HTML properly, and pre-compiles snippet tool. (#24020)
When converting all of the samples to use the snippet tool, I encountered some bugs/shortcomings:

1. The document production took 90 minutes, since the snippet tool was being invoked from the command line each time. I fixed this by snapshotting the executable before running, so it's down to 7 minutes.

2. The sample code was not being properly escaped by the snippet tool, so generics were causing issues in the HTML output. It is now quoted.

3. Code examples that used languages other than Dart were not supported. Anything that highlight.js was compiled for dartdoc with is now supported.

4. The comment color for highlight.js was light grey on white, which was pretty unreadable. It's now dark green and bold.
2018-11-07 08:29:14 -08:00
Greg Spencer 65d3ddd5d1
Dartdoc snippet extension to inject full featured code snippets in to API docs. (#23281)
This creates a custom dartdoc tool that will generate snippet blocks in our API docs that allow the user to copy easily to the clipboard, and will also embed the snippet code into a template to show it in a larger context with an app.

This PR adds the snippet tool, a template, and a couple of HTML skeleton files, one for snippets that are designed to be in an application setting, and one where it simply puts a nice container around existing snippets, making them easier to copy to the clipboard.
2018-10-23 13:50:24 -07:00
Kathy Walrath 387c458a98
Really fix the flutter dartdoc link (#22266)
It turns out that #21888 didn't really fix the link, because *this* is the README used by dartdoc for flutter.
2018-09-25 14:35:08 -07:00
Ian Hickson 6d134e0c86
Animation API improvements (#21540) 2018-09-23 00:43:05 -07:00
Ian Hickson 7d5e5ebc94
Fix broken link (#16965)
See https://docs.flutter.io/ to see what I mean.
2018-04-26 16:06:04 -07:00
jcollins-g e9541729a3
Update dartdoc to v0.18.1 and fix API readme (#16080)
* Update dartdoc to v0.18.1 and fix API readme, borrowing from docs.flutter.io
2018-03-30 12:19:44 -07:00