fix: mark Debugger deprecated (#8084)

bshaffer · web-flow · commit e6512067b986 · 2025-02-18T11:16:01.000-08:00
diff --git a/Debugger/README.md b/Debugger/README.md
@@ -6,6 +6,10 @@
 
 * [API documentation](https://cloud.google.com/php/docs/reference/cloud-debugger/latest)
 
+**IMPORTANT**: This library has been deprecated. See [Cloud Debugger Deprecation][debugger-deprecation]
+
+[debugger-deprecation]: https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
+
 **NOTE:** This repository is part of [Google Cloud PHP](https://github.com/googleapis/google-cloud-php). Any
 support requests, bug reports, or development contributions should be directed to
 that project.
diff --git a/Debugger/src/Agent.php b/Debugger/src/Agent.php
@@ -40,6 +40,7 @@
  *
  * $agent = new Agent();
  * ```
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class Agent
 {
diff --git a/Debugger/src/AliasContext.php b/Debugger/src/AliasContext.php
@@ -32,6 +32,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#aliascontext AliasContext model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class AliasContext
 {
diff --git a/Debugger/src/Breakpoint.php b/Debugger/src/Breakpoint.php
@@ -41,6 +41,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/debugger.debuggees.breakpoints#Breakpoint Breakpoint model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class Breakpoint
 {
diff --git a/Debugger/src/BreakpointStorage/FileBreakpointStorage.php b/Debugger/src/BreakpointStorage/FileBreakpointStorage.php
@@ -23,6 +23,7 @@
 
 /**
  * This implementation of BreakpointStorageInterface using a local file.
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class FileBreakpointStorage implements BreakpointStorageInterface
 {
diff --git a/Debugger/src/BreakpointStorage/SysvBreakpointStorage.php b/Debugger/src/BreakpointStorage/SysvBreakpointStorage.php
@@ -23,6 +23,7 @@
 /**
  * This implementation of BreakpointStorageInterface using PHP's shared memory
  * provided by the [Semaphore Functions](http://php.net/manual/en/ref.sem.php).
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class SysvBreakpointStorage implements BreakpointStorageInterface
 {
diff --git a/Debugger/src/BufferFullException.php b/Debugger/src/BufferFullException.php
@@ -21,6 +21,7 @@
 
 /**
  * Exception thrown when a Breakpoint has exhausted its allotted evaluation size.
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class BufferFullException extends Exception
 {
diff --git a/Debugger/src/CliDaemon.php b/Debugger/src/CliDaemon.php
@@ -23,6 +23,7 @@
 /**
  * This class handles command line options and starts a configured Debugger
  * Daemon.
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class CliDaemon
 {
diff --git a/Debugger/src/CloudRepoSourceContext.php b/Debugger/src/CloudRepoSourceContext.php
@@ -41,6 +41,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#cloudreposourcecontext CloudRepoSourceContext model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class CloudRepoSourceContext implements SourceContext
 {
diff --git a/Debugger/src/CloudWorkspaceId.php b/Debugger/src/CloudWorkspaceId.php
@@ -40,6 +40,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#cloudworkspaceid CloudWorkspaceId model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class CloudWorkspaceId
 {
diff --git a/Debugger/src/CloudWorkspaceSourceContext.php b/Debugger/src/CloudWorkspaceSourceContext.php
@@ -40,6 +40,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#cloudworkspacesourcecontext CloudWorkspaceSourceContext model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class CloudWorkspaceSourceContext implements SourceContext
 {
diff --git a/Debugger/src/Connection/Firebase.php b/Debugger/src/Connection/Firebase.php
@@ -25,6 +25,7 @@
  * Implementation of the Firebase connection
  *
  * @internal
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class Firebase implements ConnectionInterface
 {
diff --git a/Debugger/src/Connection/Grpc.php b/Debugger/src/Connection/Grpc.php
@@ -31,6 +31,7 @@
  * [Google Debugger gRPC API](https://cloud.google.com/debugger/docs/).
  *
  * @internal
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class Grpc implements ConnectionInterface
 {
diff --git a/Debugger/src/Connection/Rest.php b/Debugger/src/Connection/Rest.php
@@ -27,6 +27,7 @@
  * [Google Debugger REST API](https://cloud.google.com/debugger/docs/reference/rest/).
  *
  * @internal
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class Rest implements ConnectionInterface
 {
diff --git a/Debugger/src/Daemon.php b/Debugger/src/Daemon.php
@@ -41,6 +41,7 @@
  * $daemon = new Daemon();
  * $daemon->run();
  * ```
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class Daemon
 {
diff --git a/Debugger/src/Debuggee.php b/Debugger/src/Debuggee.php
@@ -32,6 +32,7 @@
  * ```
  *
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee Debuggee API Documentation
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class Debuggee
 {
diff --git a/Debugger/src/DebuggerClient.php b/Debugger/src/DebuggerClient.php
@@ -35,6 +35,7 @@
  *
  * $debugger = new DebuggerClient();
  * ```
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class DebuggerClient
 {
diff --git a/Debugger/src/ExtendedSourceContext.php b/Debugger/src/ExtendedSourceContext.php
@@ -33,6 +33,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#extendedsourcecontext ExtendedSourceContext model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class ExtendedSourceContext implements SourceContext
 {
diff --git a/Debugger/src/FormatMessage.php b/Debugger/src/FormatMessage.php
@@ -30,6 +30,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/debugger.debuggees.breakpoints#formatmessage FormatMessage model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class FormatMessage
 {
diff --git a/Debugger/src/GerritSourceContext.php b/Debugger/src/GerritSourceContext.php
@@ -36,6 +36,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#gerritsourcecontext GerritSourceContext model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class GerritSourceContext implements SourceContext
 {
diff --git a/Debugger/src/GitSourceContext.php b/Debugger/src/GitSourceContext.php
@@ -34,6 +34,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#gitsourcecontext GitSourceContext model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class GitSourceContext implements SourceContext
 {
diff --git a/Debugger/src/MatchingFileIterator.php b/Debugger/src/MatchingFileIterator.php
@@ -28,6 +28,7 @@
  * ```
  *
  * @access private
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class MatchingFileIterator extends \FilterIterator
 {
diff --git a/Debugger/src/ProjectRepoId.php b/Debugger/src/ProjectRepoId.php
@@ -34,6 +34,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#projectrepoid ProjectRepoId model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class ProjectRepoId
 {
diff --git a/Debugger/src/RepoId.php b/Debugger/src/RepoId.php
@@ -34,6 +34,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#repoid RepoId model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class RepoId
 {
diff --git a/Debugger/src/SourceLocation.php b/Debugger/src/SourceLocation.php
@@ -30,6 +30,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/debugger.debuggees.breakpoints#sourcelocation SourceLocation model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class SourceLocation
 {
diff --git a/Debugger/src/SourceLocationResolver.php b/Debugger/src/SourceLocationResolver.php
@@ -28,6 +28,7 @@
  * $resolver = new SourceLocationResolver();
  * $resolvedLocation = $resolver->resolve($location);
  * ```
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class SourceLocationResolver
 {
diff --git a/Debugger/src/StackFrame.php b/Debugger/src/StackFrame.php
@@ -32,6 +32,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/debugger.debuggees.breakpoints#stackframe StackFrame model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class StackFrame
 {
diff --git a/Debugger/src/StatusMessage.php b/Debugger/src/StatusMessage.php
@@ -37,6 +37,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/debugger.debuggees.breakpoints#statusmessage StatusMessage model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class StatusMessage
 {
diff --git a/Debugger/src/Variable.php b/Debugger/src/Variable.php
@@ -30,6 +30,7 @@
  * @codingStandardsIgnoreStart
  * @see https://cloud.google.com/debugger/api/reference/rest/v2/debugger.debuggees.breakpoints#variable Variable model documentation
  * @codingStandardsIgnoreEnd
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class Variable
 {
diff --git a/Debugger/src/VariableTable.php b/Debugger/src/VariableTable.php
@@ -13,6 +13,7 @@
  *
  * $variableTable = new VariableTable();
  * ```
+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
  */
 class VariableTable
 {

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@`
`40`	`40`	`*`
`41`	`41`	`* $agent = new Agent();`
`42`	`42`	* ```
	`43`	`+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation`
`43`	`44`	`*/`
`44`	`45`	`class Agent`
`45`	`46`	`{`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@`
`32`	`32`	`* @codingStandardsIgnoreStart`
`33`	`33`	`* @see https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee#aliascontext AliasContext model documentation`
`34`	`34`	`* @codingStandardsIgnoreEnd`
	`35`	`+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation`
`35`	`36`	`*/`
`36`	`37`	`class AliasContext`
`37`	`38`	`{`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@`
`41`	`41`	`* @codingStandardsIgnoreStart`
`42`	`42`	`* @see https://cloud.google.com/debugger/api/reference/rest/v2/debugger.debuggees.breakpoints#Breakpoint Breakpoint model documentation`
`43`	`43`	`* @codingStandardsIgnoreEnd`
	`44`	`+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation`
`44`	`45`	`*/`
`45`	`46`	`class Breakpoint`
`46`	`47`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`
`24`	`24`	`/**`
`25`	`25`	`* This implementation of BreakpointStorageInterface using a local file.`
	`26`	`+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation`
`26`	`27`	`*/`
`27`	`28`	`class FileBreakpointStorage implements BreakpointStorageInterface`
`28`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`
`22`	`22`	`/**`
`23`	`23`	`* Exception thrown when a Breakpoint has exhausted its allotted evaluation size.`
	`24`	`+ * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation`
`24`	`25`	`*/`
`25`	`26`	`class BufferFullException extends Exception`
`26`	`27`	`{`