Updating docs of stability/visibility annotations (#17) · googleapis/api-common-java@2742bf6 · GitHub

This repository was archived by the owner on Sep 27, 2023. It is now read-only.

googleapis / api-common-java Public archive

• Notifications You must be signed in to change notification settings
• Fork 30
• Star 21

• Code
• Pull requests
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 2742bf6

Browse filesBrowse the repository at this point in the historyBrowse files

garrettjonesgoogle

authored

Updating docs of stability/visibility annotations (#17)

1 parent b52e256 commit 2742bf6
Copy full SHA for 2742bf6

2 files changed

+9-3Lines changed: 9 additions & 3 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• src/main/java/com/google/api/core
  • BetaApi.java
  • InternalApi.java

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎src/main/java/com/google/api/core/BetaApi.java‎

Copy file name to clipboardExpand all lines: src/main/java/com/google/api/core/BetaApi.java

+2-1Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -43,7 +43,8 @@
43	43	* <p>
44	44	* Usage guidelines:
45	45	* <ol>
46		- * <li>This annotation is used only on public APIs. Internal interfaces should not use it.</li>
	46	+ * <li>This annotation is used only on APIs with public visibility. Internal interfaces should
	47	+ * not use it.</li>
47	48	* <li>This annotation should only be added to new APIs. Adding it to an existing API is considered
48	49	* API-breaking.</li>
49	50	* <li>Removing this annotation from an API gives it stable status.</li>

Collapse file

‎src/main/java/com/google/api/core/InternalApi.java‎

Copy file name to clipboardExpand all lines: src/main/java/com/google/api/core/InternalApi.java

+7-2Lines changed: 7 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -37,8 +37,13 @@
37	37	import java.lang.annotation.Target;
38	38
39	39	/**
40		- * Annotates a program element (class, method, package etc) which is internal to GAX, not part of
41		- * the public API, and should not be used by users of GAX.
	40	+ * Annotates a program element (class, method, package etc) which is internal to its
	41	+ * containing library, not part of the public API, and should not be used by users of
	42	+ * the library.
	43	+ *
	44	+ * This annotation should be used only on APIs with public visibility. Its existence
	45	+ * is necessary because Java does not have a visibility level for code within a
	46	+ * compilation unit.
42	47	*/
43	48	@BetaApi
44	49	@Retention(RetentionPolicy.SOURCE)

0 commit comments

Comments

0 (0)