Assigned
Status Update
Comments
vi...@google.com <vi...@google.com> #2
Hi Ed, Thank you so much for these suggestions. I've been reviewing them and merging them in. Hopefully it should be live. I've included a thank you note too in the article.
vi...@google.com <vi...@google.com> #3
Great! Thanks a lot, I'll look for the live updates soon!
da...@gmail.com <da...@gmail.com> #4
The androidx FragmentActivity docs are here: https://developer.android.com/reference/androidx/fragment/app/FragmentActivity .
And the androidx AppCompatActivity docs are here:https://developer.android.com/reference/androidx/appcompat/app/AppCompatActivity
The methods with misleading javadocs are:
onActivityResult
onCreate
onDestroy
onPause
onPostResume
onResume
onSaveInstanceState
onStart
onStop
Expected output:
I would expect these methods' javadocs to include the same content as the javadocs for their overridden methods in Activity.
Current output:
The javadocs look like they are instructing the user to call these methods to do things like manually destroying or pausing all fragments.
I stumbled on this because I was trying the view the javadocs in Android Studio to refresh myself on a detail of the Activity lifecycle. I do this by using the Alt-middle-click shortcut on a method in my code.
Screen record: N/A
And the androidx AppCompatActivity docs are here:
The methods with misleading javadocs are:
onActivityResult
onCreate
onDestroy
onPause
onPostResume
onResume
onSaveInstanceState
onStart
onStop
Expected output:
I would expect these methods' javadocs to include the same content as the javadocs for their overridden methods in Activity.
Current output:
The javadocs look like they are instructing the user to call these methods to do things like manually destroying or pausing all fragments.
I stumbled on this because I was trying the view the javadocs in Android Studio to refresh myself on a detail of the Activity lifecycle. I do this by using the Alt-middle-click shortcut on a method in my code.
Screen record: N/A
vi...@google.com <vi...@google.com> #5
We have passed this defect onto the development team and will update this issue with more information as it becomes available.
bn...@google.com <bn...@google.com>
il...@google.com <il...@google.com>
ap...@google.com <ap...@google.com> #6
Project: platform/frameworks/support
Branch: androidx-main
commit 65cabf4fb58e34a38216c4bb64eb75dd6d501cb7
Author: Jeremy Woods <jbwoods@google.com>
Date: Thu Feb 25 15:21:28 2021
Add @inheritDoc to override methods in FragmentActivity
Any overriden method that adds javaDoc to the new method should make the
call to @inheritDoc to ensure the previous javaDoc is also shown.
RelNote: "Overriden methods in FragmentActivity now properly inherit the
base method javaDoc"
Test: existing tests pass
Bug: 139548782
Change-Id: I736ce6ad3c248c093ccb4cdf1f40029451fd1422
M fragment/fragment/src/main/java/androidx/fragment/app/FragmentActivity.java
https://android-review.googlesource.com/1607248
Branch: androidx-main
commit 65cabf4fb58e34a38216c4bb64eb75dd6d501cb7
Author: Jeremy Woods <jbwoods@google.com>
Date: Thu Feb 25 15:21:28 2021
Add @inheritDoc to override methods in FragmentActivity
Any overriden method that adds javaDoc to the new method should make the
call to @inheritDoc to ensure the previous javaDoc is also shown.
RelNote: "Overriden methods in FragmentActivity now properly inherit the
base method javaDoc"
Test: existing tests pass
Bug: 139548782
Change-Id: I736ce6ad3c248c093ccb4cdf1f40029451fd1422
M fragment/fragment/src/main/java/androidx/fragment/app/FragmentActivity.java
Description