DEV/flutter_flutter
1
0
Fork 0
mirror of https://github.com/flutter/flutter.git synced 2026-02-20 02:29:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix some minor issues with Javadocs (flutter/engine#3761)

Browse Source
This commit is contained in:
Todd Volkert 2017-06-09 07:35:50 -07:00 committed by GitHub
parent bac6502d62
commit 923bb8cc3b
7 changed files with 48 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
engine/src/flutter/shell/platform/android/io/flutter/app/FlutterActivity.java
View File

@ -47,9 +47,9 @@ public class FlutterActivity extends Activity implements FlutterView.Provider, P
/**
* Hook for subclasses to customize the creation of the
* {@code FlutterView}.
* <p/>
* The default implementation returns {@code null}, which will cause the
* activity to use a newly instantiated full-screen view.
*
* <p>The default implementation returns {@code null}, which will cause the
* activity to use a newly instantiated full-screen view.</p>
*/
@Override
public FlutterView createFlutterView(Context context) {

20
engine/src/flutter/shell/platform/android/io/flutter/app/FlutterActivityDelegate.java
View File

@ -32,19 +32,19 @@ import java.util.Map;
/**
* Class that performs the actual work of tying Android {@link Activity}
* instances to Flutter.
* <p/>
* This exists as a dedicated class (as opposed to being integrated directly
*
* <p>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}.
* <p/>
* support library's {@code FragmentActivity}.</p>
*
* <h3>Usage:</h3>
* To wire this class up to your activity, simply forward the events defined
* <p>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.</p>
*/
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}.
* <p/>
* A delegate's view factory will be consulted during
*
* <p>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}.</p>
*/
public interface ViewFactory {
FlutterView createFlutterView(Context context);

12
engine/src/flutter/shell/platform/android/io/flutter/app/FlutterActivityEvents.java
View File

@ -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.
* <p/>
* 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}.
*
* <p>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}.</p>
*/
public interface FlutterActivityEvents
extends ComponentCallbacks2, ActivityResultListener, RequestPermissionResultListener {

14
engine/src/flutter/shell/platform/android/io/flutter/app/FlutterFragmentActivity.java
View File

@ -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.
* <p/>
* <strong>Important!</strong> Flutter does not bundle the necessary Android
*
* <p><strong>Important!</strong> 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.</p>
*
* @see https://developer.android.com/topic/libraries/support-library/setup.html
* @see <a target="_new" href="https://developer.android.com/topic/libraries/support-library/setup.html">https://developer.android.com/topic/libraries/support-library/setup.html</a>
*/
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}.
* <p/>
* The default implementation returns {@code null}, which will cause the
* activity to use a newly instantiated full-screen view.
*
* <p>The default implementation returns {@code null}, which will cause the
* activity to use a newly instantiated full-screen view.</p>
*/
@Override
public FlutterView createFlutterView(Context context) {

14
engine/src/flutter/shell/platform/android/io/flutter/plugin/common/PluginRegistry.java
View File

@ -58,12 +58,12 @@ public interface PluginRegistry {
interface Registrar {
/**
* Returns the {@link Activity} that forms the plugin's operating context.
* <p/>
* Plugin authors should not assume the type returned by this method
*
* <p>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.</p>
*/
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}.

12
engine/src/flutter/shell/platform/android/io/flutter/view/FlutterView.java
View File

@ -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).
* <p/>
* 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}.
*
* <p>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}.</p>
*/
public interface Provider {
/**

13
engine/src/flutter/tools/gen_javadoc.py
View File

@ -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__':