C#: Improve some of the QL Doc string.

This commit is contained in:
Michael Nebel
2022-03-21 14:24:51 +01:00
parent 4a68b74aa3
commit 8e2277e4f3
2 changed files with 6 additions and 6 deletions

View File

@@ -2033,7 +2033,7 @@ abstract class SyntheticField extends string {
predicate containerContent(DataFlow::Content c) { c instanceof DataFlow::ElementContent }
/**
* Module containing predicates related to generating models as data.
* A module containing predicates related to generating models as data.
*/
module Csv {
private string parameterQualifiedTypeNamesToString(DataFlowCallable c) {
@@ -2045,7 +2045,7 @@ module Csv {
)
}
/** Holds if the summary should apply for all overrides of this. */
/** Holds if the summary should apply for all overrides of `c`. */
predicate isBaseCallableOrPrototype(DataFlowCallable c) {
c.getDeclaringType() instanceof Interface
or
@@ -2056,12 +2056,12 @@ module Csv {
)
}
/** Gets a string representing whether the summary should apply for all overrides of this. */
/** Gets a string representing whether the summary should apply for all overrides of `c`. */
private string getCallableOverride(DataFlowCallable c) {
if isBaseCallableOrPrototype(c) then result = "true" else result = "false"
}
/** Computes the first 6 columns for CSV rows. */
/** Computes the first 6 columns for CSV rows of `c`. */
string asPartialModel(DataFlowCallable c) {
exists(string namespace, string type |
c.getDeclaringType().hasQualifiedName(namespace, type) and

View File

@@ -7,9 +7,9 @@ private import semmle.code.csharp.dataflow.internal.DataFlowDispatch
private predicate isRelevantForModels(Callable api) { not api instanceof MainMethod }
/**
* A class of DataFlowCallables that are relevant generating summary, source and sinks models for.
* A class of callables that are relevant generating summary, source and sinks models for.
*
* In the Standard library and 3rd party libraries it the Callables that can be called
* In the Standard library and 3rd party libraries it the callables that can be called
* from outside the library itself.
*/
class TargetApi extends DataFlowCallable {