Cleaning up unnecessary use of "@hide annotations" (b/177448055) #2544
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ramanpreetSinghKhinda
requested review from
vkryachko,
visumickey and
jeremyjiang-dev
ramanpreetSinghKhinda
changed the title
Coverage ReportAffected SDKsNo changes between base commit (39ce055) and head commit (31b0513b). Test Logs
NotesHTML coverage reports can be produced locally with Head commit (31b0513b) is created by Prow via merging commits: 39ce055 cdaa292. |
Binary Size ReportAffected SDKs
Test Logs
NotesHead commit (31b0513b) is created by Prow via merging commits: 39ce055 cdaa292. |
jeremyjiang-dev
approved these changes
Mar 25, 2021
|
Merge this PR after #2545. Reason: #2546 (comment) |
|
/test smoke-tests |
visumickey
reviewed
Mar 29, 2021
firebase-perf/src/main/java/com/google/firebase/perf/application/AppStateMonitor.java
Outdated
Show resolved
Hide resolved
vkryachko
approved these changes
Mar 29, 2021
visumickey
approved these changes
Mar 29, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Few Points:
We should be using
@hidejavadoc annotation to hide certain packages/classes/methods (which are declared public) to be considered a part of public API.Double use of
@hidejavadoc annotation is not required. This was a requirement with GmsCore (go/gmscore-hide-annotation-lsc). Also that second annotation was@HideJava annotation (which is a GmsCore annotation) and not@hidejavadoc annotation (which is a general javadoc annotation) which seems like happened during code migration to GitHub.This annotation should only be used in public classes/methods.
Adding this annotation to the method will hide that method.
Adding this annotation to the class level will hide the entire class and its public methods.
Adding this annotation to the package declaration in the
package-info.javaclass makes the entire classes within that package to be hidden. Note that this does not work transitively for child packages and so each child package would also need there ownpackage-info.javaclass.There's no way currently to not hide some of the classes/methods when the entire package is marked hidden. So in that case where a package contains some classes/methods which has to be public than we have to apply this annotation class/method wise.
What does
hidingmeans?FAQs
No, I have already validated everything by running the below command and no change was detected (caveat: sometimes you have to touch the
api.txtfile to trigger the run).WANT_LGTM = @vkryachko