Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Added javadoc comments to FlutterActivity and FlutterFragmentActivity. #12328

Merged
matthew-carroll merged 2 commits into from
Sep 17, 2019
Merged

Added javadoc comments to FlutterActivity and FlutterFragmentActivity. #12328

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
077402c
Added javadoc comments to FlutterActivity and FlutterFragmentActivity.
matthew-carroll Sep 17, 2019
5a7cbe5
Updated new comments.
matthew-carroll Sep 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions shell/platform/android/io/flutter/embedding/android/FlutterActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,10 @@
* android:value="true"
* />
* }
* <p>
* A number of methods in this class have the same implementation as

@xster xster Sep 17, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these be javadocs? I don't think people want to see it in https://api.flutter.dev/javadoc/ right? Maybe split this into 2 parts. Reference the other alternative in javadocs for users and leave a code comment for other maintainers.

@matthew-carroll matthew-carroll Sep 17, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. Made the changes.

@xster xster Sep 17, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG

* {@link FlutterFragmentActivity}. These methods are duplicated for readability purposes. Be sure
* to replicate any change in this class in {@link FlutterFragmentActivity}, too.
*/
public class FlutterActivity extends Activity
implements FlutterActivityAndFragmentDelegate.Host,
Expand Down
4 changes: 4 additions & 0 deletions shell/platform/android/io/flutter/embedding/android/FlutterFragmentActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@
* regular {@link FlutterActivity} instead, because {@link FlutterActivity}
* is considered to be the standard, canonical implementation of a Flutter
* {@code Activity}.
* <p>
* A number of methods in this class have the same implementation as {@link FlutterActivity}. These
* methods are duplicated for readability purposes. Be sure to replicate any change in this class
* in {@link FlutterActivity}, too.
*/
public class FlutterFragmentActivity extends FragmentActivity
implements SplashScreenProvider,
Expand Down