From 6873cdfe300cf556255011608c02141d4f8d891c Mon Sep 17 00:00:00 2001 From: Jason Simmons Date: Thu, 9 Feb 2017 16:12:09 -0800 Subject: [PATCH] Add a fake package that generates a link to the Android javadocs in the dartdoc output (#8032) Fixes https://github.com/flutter/flutter/issues/7963 --- dev/docs/platform_integration/lib/android.dart | 2 ++ dev/docs/platform_integration/pubspec.yaml | 2 ++ dev/tools/dartdoc.dart | 15 +++++++++++++++ 3 files changed, 19 insertions(+) create mode 100644 dev/docs/platform_integration/lib/android.dart create mode 100644 dev/docs/platform_integration/pubspec.yaml diff --git a/dev/docs/platform_integration/lib/android.dart b/dev/docs/platform_integration/lib/android.dart new file mode 100644 index 0000000000..c9c119f718 --- /dev/null +++ b/dev/docs/platform_integration/lib/android.dart @@ -0,0 +1,2 @@ +/// [Flutter platform integration APIs for Android.](https://docs.flutter.io/javadoc/) +library Android; diff --git a/dev/docs/platform_integration/pubspec.yaml b/dev/docs/platform_integration/pubspec.yaml new file mode 100644 index 0000000000..6fefc80ae6 --- /dev/null +++ b/dev/docs/platform_integration/pubspec.yaml @@ -0,0 +1,2 @@ +name: platform_integration + diff --git a/dev/tools/dartdoc.dart b/dev/tools/dartdoc.dart index 777015760e..25fa48d73a 100644 --- a/dev/tools/dartdoc.dart +++ b/dev/tools/dartdoc.dart @@ -32,6 +32,10 @@ dependencies: buf.writeln(' $package:'); buf.writeln(' sdk: flutter'); } + buf.writeln(' platform_integration: 0.0.1'); + buf.writeln('dependency_overrides:'); + buf.writeln(' platform_integration:'); + buf.writeln(' path: platform_integration'); new File('dev/docs/pubspec.yaml').writeAsStringSync(buf.toString()); // Create the library file. @@ -67,6 +71,7 @@ dependencies: '--use-categories' ]; + for (String libraryRef in libraryRefs(diskPath: true)) { args.add('--include-external'); args.add(libraryRef); @@ -134,6 +139,10 @@ void addHtmlBaseToIndex() { String indexContents = indexFile.readAsStringSync(); indexContents = indexContents.replaceFirst('\n', '\n \n'); + indexContents = indexContents.replaceAll( + 'href="Android/Android-library.html"', + 'href="https://docs.flutter.io/javadoc/"' + ); indexFile.writeAsStringSync(indexContents); } @@ -175,6 +184,12 @@ Iterable libraryRefs({ bool diskPath: false }) sync* { } } } + + // Add a fake package for platform integration APIs. + if (diskPath) + yield 'platform_integration/lib/android.dart'; + else + yield 'platform_integration/android.dart'; } void printStream(Stream> stream) {