docs: Update the Javadoc of ObsoleteApi.java (#3088)

blakeli0 · web-flow · commit 7ed2a7e49265 · 2024-08-07T11:10:07.000-04:00
Update the Javadoc of ObsoleteApi.java. It's preferred to provide
reasons and alternatives directly in the description, rather than links,
as links are not stable.
diff --git a/sdk-platform-java/api-common-java/src/main/java/com/google/api/core/ObsoleteApi.java b/sdk-platform-java/api-common-java/src/main/java/com/google/api/core/ObsoleteApi.java
@@ -60,6 +60,6 @@
 })
 @Documented
 public @interface ObsoleteApi {
-  /** Context information such as links to a discussion thread, tracking issue, etc. */
+  /** Context information such as reasons and alternatives. */
   String value();
 }

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,6 @@`
`60`	`60`	`})`
`61`	`61`	`@Documented`
`62`	`62`	`public @interface ObsoleteApi {`
`63`		`- /** Context information such as links to a discussion thread, tracking issue, etc. */`
	`63`	`+ /** Context information such as reasons and alternatives. */`
`64`	`64`	`String value();`
`65`	`65`	`}`