The default implementation returns {@code null}, which will cause the + * activity to use a newly instantiated full-screen view.
*/ @Override public FlutterView createFlutterView(Context context) { diff --git a/shell/platform/android/io/flutter/app/FlutterActivityDelegate.java b/shell/platform/android/io/flutter/app/FlutterActivityDelegate.java index 40e8c6f8553d019464dc1766110bf9d0c1efa0f3..f299a08708f8cee4f4540b730e726ea6d7a7fa34 100644 --- a/shell/platform/android/io/flutter/app/FlutterActivityDelegate.java +++ b/shell/platform/android/io/flutter/app/FlutterActivityDelegate.java @@ -32,19 +32,19 @@ import java.util.Map; /** * Class that performs the actual work of tying Android {@link Activity} * instances to Flutter. - * - * This exists as a dedicated class (as opposed to being integrated directly + * + *This exists as a dedicated class (as opposed to being integrated directly * into {@link FlutterActivity}) to facilitate applications that don't wish * to subclass {@code FlutterActivity}. The most obvious example of when this * may come in handy is if an application wishes to subclass the Android v4 - * support library's {@code FragmentActivity}. - *
+ * support library's {@code FragmentActivity}. + * *To wire this class up to your activity, simply forward the events defined * in {@link FlutterActivityEvents} from your activity to an instance of this * class. Optionally, you can make your activity implement - * {@link PluginRegistry} and/or {@link FlutterView.Provider} and forward those - * methods to this class as well. + * {@link PluginRegistry} and/or {@link io.flutter.view.FlutterView.Provider} + * and forward those methods to this class as well.
*/ public final class FlutterActivityDelegate implements FlutterActivityEvents, @@ -53,10 +53,10 @@ public final class FlutterActivityDelegate /** * Specifies the mechanism by which Flutter views are created during the * operation of a {@code FlutterActivityDelegate}. - * - * A delegate's view factory will be consulted during + * + *A delegate's view factory will be consulted during * {@link #onCreate(Bundle)}. If it returns {@code null}, then the delegate - * will fall back to instantiating a new full-screen {@code FlutterView}. + * will fall back to instantiating a new full-screen {@code FlutterView}.
*/ public interface ViewFactory { FlutterView createFlutterView(Context context); diff --git a/shell/platform/android/io/flutter/app/FlutterActivityEvents.java b/shell/platform/android/io/flutter/app/FlutterActivityEvents.java index d98639b4571ae3cee3bf5617aa7c9a7985a7b2ac..728bc90eb7f08729db61ee44a6330f1fe6651b4f 100644 --- a/shell/platform/android/io/flutter/app/FlutterActivityEvents.java +++ b/shell/platform/android/io/flutter/app/FlutterActivityEvents.java @@ -13,12 +13,12 @@ import io.flutter.plugin.common.PluginRegistry.RequestPermissionResultListener; /** * A collection of Android {@code Activity} methods that are relevant to the * core operation of Flutter applications. - * - * Application authors that use an activity other than {@link FlutterActivity} - * should forward all events herein from their activity to an instance of - * {@link FlutterActivityDelegate} in order to wire the activity up to the - * Flutter framework. This forwarding is already provided in - * {@code FlutterActivity}. + * + *Application authors that use an activity other than + * {@link FlutterActivity} should forward all events herein from their activity + * to an instance of {@link FlutterActivityDelegate} in order to wire the + * activity up to the Flutter framework. This forwarding is already provided in + * {@code FlutterActivity}.
*/ public interface FlutterActivityEvents extends ComponentCallbacks2, ActivityResultListener, RequestPermissionResultListener { diff --git a/shell/platform/android/io/flutter/app/FlutterFragmentActivity.java b/shell/platform/android/io/flutter/app/FlutterFragmentActivity.java index 12f9fbe632889af0c32d64c246e750ad61d8df8f..789424b917a9944a168eb82ed6bb3fc082f6e314 100644 --- a/shell/platform/android/io/flutter/app/FlutterFragmentActivity.java +++ b/shell/platform/android/io/flutter/app/FlutterFragmentActivity.java @@ -18,14 +18,14 @@ import io.flutter.view.FlutterView; * Base class for activities that use Flutter who also require the use of the * Android v4 Support library's {@link FragmentActivity}. Applications that * don't have this need will likely want to use {@link FlutterActivity} instead. - * - * Important! Flutter does not bundle the necessary Android + * + *Important! Flutter does not bundle the necessary Android * v4 Support library classes for this class to work at runtime. It is the * responsibility of the app developer using this class to ensure that they * link against the v4 support library .jar file when creating their app to - * ensure that {@link FragmentActivity} is available at runtime. + * ensure that {@link FragmentActivity} is available at runtime.
* - * @see https://developer.android.com/topic/libraries/support-library/setup.html + * @see https://developer.android.com/topic/libraries/support-library/setup.html */ public class FlutterFragmentActivity extends FragmentActivity implements FlutterView.Provider, PluginRegistry, ViewFactory { @@ -49,9 +49,9 @@ public class FlutterFragmentActivity /** * Hook for subclasses to customize the creation of the * {@code FlutterView}. - * - * The default implementation returns {@code null}, which will cause the - * activity to use a newly instantiated full-screen view. + * + *The default implementation returns {@code null}, which will cause the + * activity to use a newly instantiated full-screen view.
*/ @Override public FlutterView createFlutterView(Context context) { diff --git a/shell/platform/android/io/flutter/plugin/common/PluginRegistry.java b/shell/platform/android/io/flutter/plugin/common/PluginRegistry.java index 2f7599113e6edbe28aaa236950e48afb1a32d959..45f4c078b5de01588be17460ed36f4efd8cb2a02 100644 --- a/shell/platform/android/io/flutter/plugin/common/PluginRegistry.java +++ b/shell/platform/android/io/flutter/plugin/common/PluginRegistry.java @@ -58,12 +58,12 @@ public interface PluginRegistry { interface Registrar { /** * Returns the {@link Activity} that forms the plugin's operating context. - * - * Plugin authors should not assume the type returned by this method + * + *Plugin authors should not assume the type returned by this method * is any specific subclass of {@code Activity} (such as * {@link io.flutter.app.FlutterActivity} or * {@link io.flutter.app.FlutterFragmentActivity}), as applications - * are free to use any activity subclass. + * are free to use any activity subclass.
*/ Activity activity(); @@ -92,7 +92,7 @@ public interface PluginRegistry { /** * Adds a callback allowing the plugin to take part in handling incoming - * calls to {@Activity#onRequestPermissionsResult(int, String[], int[])} + * calls to {@link Activity#onRequestPermissionsResult(int, String[], int[])} * or {android.support.v4.app.ActivityCompat.OnRequestPermissionsResultCallback#onRequestPermissionsResult(int, String[], int[])}. * * @param listener a {@link RequestPermissionResultListener} callback. @@ -102,7 +102,7 @@ public interface PluginRegistry { /** * Adds a callback allowing the plugin to take part in handling incoming - * calls to {@Activity#onActivityResult(int, int, Intent)}. + * calls to {@link Activity#onActivityResult(int, int, Intent)}. * * @param listener an {@link ActivityResultListener} callback. * @return this {@link Registrar}. @@ -111,7 +111,7 @@ public interface PluginRegistry { /** * Adds a callback allowing the plugin to take part in handling incoming - * calls to {@Activity#onNewIntent(Intent)}. + * calls to {@link Activity#onNewIntent(Intent)}. * * @param listener a {@link NewIntentListener} callback. * @return this {@link Registrar}. @@ -120,7 +120,7 @@ public interface PluginRegistry { /** * Adds a callback allowing the plugin to take part in handling incoming - * calls to {@Activity#onUserLeaveHint()}. + * calls to {@link Activity#onUserLeaveHint()}. * * @param listener a {@link UserLeaveHintListener} callback. * @return this {@link Registrar}. diff --git a/shell/platform/android/io/flutter/view/FlutterView.java b/shell/platform/android/io/flutter/view/FlutterView.java index d789c74e666fd9172f3adeb873f6d0ceb14b225b..8602ba252f59b022a2a1dc6d0c4fee0b2a4eb2fb 100644 --- a/shell/platform/android/io/flutter/view/FlutterView.java +++ b/shell/platform/android/io/flutter/view/FlutterView.java @@ -59,12 +59,12 @@ public class FlutterView extends SurfaceView /** * Interface for those objects that maintain and expose a reference to a * {@code FlutterView} (such as a full-screen Flutter activity). - * - * This indirection is provided to support applications that use an - * activity other than {@link FlutterActivity} (e.g. Android v4 support - * library's {@code FragmentActivity}). It allows Flutter plugins to deal - * in this interface and not require that the activity be a subclass of - * {@code FlutterActivity}. + * + *This indirection is provided to support applications that use an + * activity other than {@link io.flutter.app.FlutterActivity} (e.g. Android + * v4 support library's {@code FragmentActivity}). It allows Flutter plugins + * to deal in this interface and not require that the activity be a subclass + * of {@code FlutterActivity}.
*/ public interface Provider { /** diff --git a/tools/gen_javadoc.py b/tools/gen_javadoc.py index 6c321631a875e2692f4efaa86fd8b3ff3ec6cd1d..fbc28a8682e0c42ae10428d116efeeb4ef6b859f 100755 --- a/tools/gen_javadoc.py +++ b/tools/gen_javadoc.py @@ -32,17 +32,22 @@ def main(): ] packages = [ 'io.flutter.app', - 'io.flutter.view', - 'io.flutter.plugin.editing', 'io.flutter.plugin.common', + 'io.flutter.plugin.editing', 'io.flutter.plugin.platform', + 'io.flutter.util', + 'io.flutter.view', ] - return subprocess.call([ + command = [ 'javadoc', '-classpath', ':'.join(classpath), '-d', args.out_dir, - ] + packages) + '-link', 'https://developer.android.com/reference/', + ] + packages + print(' '.join(command)) + + return subprocess.call(command) if __name__ == '__main__':