C#: Make Annotations module private. Update comments.

calumgrant · calumgrant · commit d46848ed109a · 2019-06-26T20:24:55.000+01:00
diff --git a/csharp/ql/src/semmle/code/csharp/AnnotatedType.qll b/csharp/ql/src/semmle/code/csharp/AnnotatedType.qll
@@ -8,7 +8,7 @@
 
 import csharp
 
-module Annotations {
+private module Annotations {
   private newtype TAnnotation =
     TDisabledNullability() or
     TNotApplicableNullability() or
diff --git a/csharp/ql/src/semmle/code/csharp/Callable.qll b/csharp/ql/src/semmle/code/csharp/Callable.qll
@@ -25,12 +25,12 @@ class Callable extends DotNet::Callable, Parameterizable, ExprOrStmtParent, @cal
   /** Gets the annotated return type of this callable. */
   final AnnotatedType getAnnotatedReturnType() { result.appliesTo(this) }
 
-  /** Holds if this callable returns a `ref`. */
+  /** DEPRECATED: Use `getAnnotatedReturnType().isRef()` instead. */
   deprecated predicate returnsRef() {
     this.getAnnotatedReturnType().isRef()
   }
 
-  /** Holds if this callable returns a `ref readonly`. */
+  /** DEPRECATED: Use `getAnnotatedReturnType().isReadonlyRef()` instead. */
   deprecated predicate returnsRefReadonly() {
     this.getAnnotatedReturnType().isReadonlyRef()
   }

Original file line number	Diff line number	Diff line change
`@@ -25,12 +25,12 @@ class Callable extends DotNet::Callable, Parameterizable, ExprOrStmtParent, @cal`
`25`	`25`	`/** Gets the annotated return type of this callable. */`
`26`	`26`	`final AnnotatedType getAnnotatedReturnType() { result.appliesTo(this) }`
`27`	`27`
`28`		- /** Holds if this callable returns a `ref`. */
	`28`	+ /** DEPRECATED: Use `getAnnotatedReturnType().isRef()` instead. */
`29`	`29`	`deprecated predicate returnsRef() {`
`30`	`30`	`this.getAnnotatedReturnType().isRef()`
`31`	`31`	`}`
`32`	`32`
`33`		- /** Holds if this callable returns a `ref readonly`. */
	`33`	+ /** DEPRECATED: Use `getAnnotatedReturnType().isReadonlyRef()` instead. */
`34`	`34`	`deprecated predicate returnsRefReadonly() {`
`35`	`35`	`this.getAnnotatedReturnType().isReadonlyRef()`
`36`	`36`	`}`