C#: Add documentation.

calumgrant · calumgrant · commit 92eb857dacce · 2019-01-31T17:46:28.000Z
diff --git a/csharp/ql/src/semmle/code/csharp/dataflow/LibraryTypeDataFlow.qll b/csharp/ql/src/semmle/code/csharp/dataflow/LibraryTypeDataFlow.qll
@@ -184,12 +184,6 @@ class CallableFlowSourceArg extends CallableFlowSource, TCallableFlowSourceArg {
   override Expr getSource(Call c) { result = c.getArgument(getArgumentIndex()) }
 }
 
-/** Gets an argument flow source for callable `callable` with argument `i`. */
-CallableFlowSourceArg getFlowSourceArg(SourceDeclarationCallable callable, int i) {
-  i = result.getArgumentIndex() and
-  hasArgumentPosition(callable, i)
-}
-
 /** A flow source in a call to a library callable: output from delegate argument. */
 class CallableFlowSourceDelegateArg extends CallableFlowSource, TCallableFlowSourceDelegateArg {
   override string toString() { result = "output from argument " + getArgumentIndex().toString() }
@@ -243,17 +237,25 @@ class CallableFlowSinkArg extends CallableFlowSink, TCallableFlowSinkArg {
   }
 }
 
-/** Gets an argument flow sink for callable `callable` with argument `i`. */
+/** Gets the flow source for argument `i` of callable `callable`. */
+CallableFlowSourceArg getFlowSourceArg(SourceDeclarationCallable callable, int i) {
+  i = result.getArgumentIndex() and
+  hasArgumentPosition(callable, i)
+}
+
+/** Gets the flow sink for argument `i` of callable `callable`. */
 CallableFlowSinkArg getFlowSinkArg(SourceDeclarationCallable callable, int i) {
   i = result.getArgumentIndex() and
   hasArgumentPosition(callable, i)
 }
 
+/** Gets the flow source for argument `i` of delegate `callable`. */
 CallableFlowSourceDelegateArg getDelegateFlowSourceArg(SourceDeclarationCallable callable, int i) {
   i = result.getArgumentIndex() and
   hasDelegateArgumentPosition(callable, i)
 }
 
+/** Gets the flow sink for the `j`th argument of the delegate at argument `i` of `callable`. */
 CallableFlowSinkDelegateArg getDelegateFlowSinkArg(SourceDeclarationCallable callable, int i, int j) {
   result = TCallableFlowSinkDelegateArg(i, j) and
   hasDelegateArgumentPosition2(callable, i, j)
