Ruby: Add more deprecation comments

hvitved · hvitved · commit c6e805faefab · 2023-12-05T14:57:15.000+01:00
diff --git a/ruby/ql/lib/codeql/ruby/typetracking/TypeTracker.qll b/ruby/ql/lib/codeql/ruby/typetracking/TypeTracker.qll
@@ -1,4 +1,8 @@
-/** Step Summaries and Type Tracking */
+/**
+ * DEPRECATED: Use `codeql.ruby.typetracking.TypeTracking` instead.
+ *
+ * Step Summaries and Type Tracking
+ */
 
 private import TypeTrackerSpecific
 
@@ -419,6 +423,8 @@ deprecated module StepSummary {
 }
 
 /**
+ * DEPRECATED: Use `codeql.ruby.typetracking.TypeTracking` instead.
+ *
  * A summary of the steps needed to track a value to a given dataflow node.
  *
  * This can be used to track objects that implement a certain API in order to
@@ -597,6 +603,8 @@ deprecated private predicate backSmallstepProj(TypeTrackingNode nodeTo, StepSumm
 }
 
 /**
+ * DEPRECATED: Use `codeql.ruby.typetracking.TypeTracking` instead.
+ *
  * A summary of the steps needed to back-track a use of a value to a given dataflow node.
  *
  * This can for example be used to track callbacks that are passed to a certain API,

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`		`-/** Step Summaries and Type Tracking */`
	`1`	`+/**`
	`2`	+ * DEPRECATED: Use `codeql.ruby.typetracking.TypeTracking` instead.
	`3`	`+ *`
	`4`	`+ * Step Summaries and Type Tracking`
	`5`	`+ */`
`2`	`6`
`3`	`7`	`private import TypeTrackerSpecific`
`4`	`8`
`@@ -419,6 +423,8 @@ deprecated module StepSummary {`
`419`	`423`	`}`
`420`	`424`
`421`	`425`	`/**`
	`426`	+ * DEPRECATED: Use `codeql.ruby.typetracking.TypeTracking` instead.
	`427`	`+ *`
`422`	`428`	`* A summary of the steps needed to track a value to a given dataflow node.`
`423`	`429`	`*`
`424`	`430`	`* This can be used to track objects that implement a certain API in order to`
`@@ -597,6 +603,8 @@ deprecated private predicate backSmallstepProj(TypeTrackingNode nodeTo, StepSumm`
`597`	`603`	`}`
`598`	`604`
`599`	`605`	`/**`
	`606`	+ * DEPRECATED: Use `codeql.ruby.typetracking.TypeTracking` instead.
	`607`	`+ *`
`600`	`608`	`* A summary of the steps needed to back-track a use of a value to a given dataflow node.`
`601`	`609`	`*`
`602`	`610`	`* This can for example be used to track callbacks that are passed to a certain API,`