Java: update some qldocs

Jami Cogswell · Jami Cogswell · commit aca538310f60 · 2023-03-31T18:02:09.000-04:00
diff --git a/java/ql/src/Metrics/Summaries/GeneratedVsManualCoverageQuery.qll b/java/ql/src/Metrics/Summaries/GeneratedVsManualCoverageQuery.qll
@@ -42,7 +42,7 @@ private int getNumApis(string package, string apiSubset) {
     )
 }
 
-/** TODO */
+/** Holds if the given `callable` belongs to the specified `apiSubset`. */
 private predicate callableSubset(Callable callable, string apiSubset) {
   apiSubset in ["topJdkApis", "allApis"] and
   (
@@ -52,7 +52,10 @@ private predicate callableSubset(Callable callable, string apiSubset) {
   )
 }
 
-/** TODO */
+/**
+ * Provides MaD summary model coverage information for the given `package`
+ * on the given `apiSubset`.
+ */
 predicate modelCoverageGenVsMan(
   string package, int generatedOnly, int both, int manualOnly, int non, int all, float coverage,
   float generatedCoverage, float manualCoverage, float manualCoveredByGenerated,

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ private int getNumApis(string package, string apiSubset) {`
`42`	`42`	`)`
`43`	`43`	`}`
`44`	`44`
`45`		`-/** TODO */`
	`45`	+/** Holds if the given `callable` belongs to the specified `apiSubset`. */
`46`	`46`	`private predicate callableSubset(Callable callable, string apiSubset) {`
`47`	`47`	`apiSubset in ["topJdkApis", "allApis"] and`
`48`	`48`	`(`
`@@ -52,7 +52,10 @@ private predicate callableSubset(Callable callable, string apiSubset) {`
`52`	`52`	`)`
`53`	`53`	`}`
`54`	`54`
`55`		`-/** TODO */`
	`55`	`+/**`
	`56`	+ * Provides MaD summary model coverage information for the given `package`
	`57`	+ * on the given `apiSubset`.
	`58`	`+ */`
`56`	`59`	`predicate modelCoverageGenVsMan(`
`57`	`60`	`string package, int generatedOnly, int both, int manualOnly, int non, int all, float coverage,`
`58`	`61`	`float generatedCoverage, float manualCoverage, float manualCoveredByGenerated,`