Add missing QLDocs in JaxWS.qll

owen-mc · owen-mc · commit 07f7fd0342cb · 2021-06-10T10:43:15.000+01:00
And correct one QLDoc
diff --git a/java/ql/src/semmle/code/java/frameworks/JaxWS.qll b/java/ql/src/semmle/code/java/frameworks/JaxWS.qll
@@ -30,6 +30,7 @@ class JaxWsEndpoint extends Class {
     )
   }
 
+  /** Gets a method annotated with `@WebMethod` or `@WebEndpoint`. */
   Callable getARemoteMethod() {
     result = this.getACallable() and
     exists(AnnotationType a | a = result.getAnAnnotation().getType() |
@@ -210,10 +211,16 @@ class JaxRsInjectionAnnotation extends JaxRSAnnotation {
   }
 }
 
+/**
+ * The class `javax.ws.rs.core.Response`.
+ */
 class JaxRsResponse extends Class {
   JaxRsResponse() { this.hasQualifiedName(getAJaxRsPackage("core"), "Response") }
 }
 
+/**
+ * The class `javax.ws.rs.core.Response$ResponseBuilder`.
+ */
 class JaxRsResponseBuilder extends Class {
   JaxRsResponseBuilder() {
     this.hasQualifiedName(getAJaxRsPackage("core"), "Response$ResponseBuilder")
@@ -408,7 +415,7 @@ private class HttpHeadersModel extends SummaryModelCsv {
 }
 
 /**
- * Model MultivaluedMap, which extends Map<List<K>, V> and provides a few extra helper methods.
+ * Model MultivaluedMap, which extends Map<K, List<V>> and provides a few extra helper methods.
  */
 private class MultivaluedMapModel extends SummaryModelCsv {
   override predicate row(string row) {

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ class JaxWsEndpoint extends Class {`
`30`	`30`	`)`
`31`	`31`	`}`
`32`	`32`
	`33`	+ /** Gets a method annotated with `@WebMethod` or `@WebEndpoint`. */
`33`	`34`	`Callable getARemoteMethod() {`
`34`	`35`	`result = this.getACallable() and`
`35`	`36`	`exists(AnnotationType a \| a = result.getAnAnnotation().getType() \|`
`@@ -210,10 +211,16 @@ class JaxRsInjectionAnnotation extends JaxRSAnnotation {`
`210`	`211`	`}`
`211`	`212`	`}`
`212`	`213`
	`214`	`+/**`
	`215`	+ * The class `javax.ws.rs.core.Response`.
	`216`	`+ */`
`213`	`217`	`class JaxRsResponse extends Class {`
`214`	`218`	`JaxRsResponse() { this.hasQualifiedName(getAJaxRsPackage("core"), "Response") }`
`215`	`219`	`}`
`216`	`220`
	`221`	`+/**`
	`222`	+ * The class `javax.ws.rs.core.Response$ResponseBuilder`.
	`223`	`+ */`
`217`	`224`	`class JaxRsResponseBuilder extends Class {`
`218`	`225`	`JaxRsResponseBuilder() {`
`219`	`226`	`this.hasQualifiedName(getAJaxRsPackage("core"), "Response$ResponseBuilder")`
`@@ -408,7 +415,7 @@ private class HttpHeadersModel extends SummaryModelCsv {`
`408`	`415`	`}`
`409`	`416`
`410`	`417`	`/**`
`411`		`- * Model MultivaluedMap, which extends Map<List<K>, V> and provides a few extra helper methods.`
	`418`	`+ * Model MultivaluedMap, which extends Map<K, List<V>> and provides a few extra helper methods.`
`412`	`419`	`*/`
`413`	`420`	`private class MultivaluedMapModel extends SummaryModelCsv {`
`414`	`421`	`override predicate row(string row) {`