Skip to content

Commit 50f1277

Browse files
authored
Add comment to @publicapi making it clear its only a convention for non-proguarded projects. (#263)
1 parent f474060 commit 50f1277

File tree

1 file changed

+4
-0
lines changed
  • firebase-common/src/main/java/com/google/firebase/annotations

1 file changed

+4
-0
lines changed

firebase-common/src/main/java/com/google/firebase/annotations/PublicApi.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
/**
2222
* Indicates that this object (class, method, etc) should be retained while preguarding an SDK, but
2323
* is safe to be proguarded away in the final app.
24+
*
25+
* <p>NOTE: For projects /not/ using proguard, the PublicApi annotation acts merely as a convention
26+
* and has no actual impact. These projects must abide by normal java visibility rules to govern the
27+
* visibility of methods in their public API.
2428
*/
2529
@KeepForSdk
2630
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR})

0 commit comments

Comments
 (0)