Python: Add missing QLDoc

RasmusWL · RasmusWL · commit e82ad6fc22a7 · 2021-06-07T10:13:26.000+02:00
diff --git a/python/ql/src/semmle/python/frameworks/Aiohttp.qll b/python/ql/src/semmle/python/frameworks/Aiohttp.qll
@@ -328,6 +328,10 @@ module AiohttpWebModel {
     override string getSourceType() { result = "aiohttp.web.Request" }
   }
 
+  /**
+   * A read of the `request` attribute on an instance of a aiohttp.web View class,
+   * which is the request being processed currently.
+   */
   class AiohttpViewClassRequestAttributeRead extends Request::InstanceSource,
     RemoteFlowSource::Range, DataFlow::Node {
     AiohttpViewClassRequestAttributeRead() {
@@ -378,13 +382,15 @@ module AiohttpWebModel {
     }
   }
 
+  /** An attribute read on a `aiohttp.web.Request` that is a `MultiDictProxy` instance. */
   class AiohttpRequestMultiDictProxyInstances extends Multidict::MultiDictProxy::InstanceSource {
     AiohttpRequestMultiDictProxyInstances() {
       this.(DataFlow::AttrRead).getObject() = Request::instance() and
       this.(DataFlow::AttrRead).getAttributeName() in ["query", "headers"]
     }
   }
 
+  /** An attribute read on a `aiohttp.web.Request` that is a `yarl.URL` instance. */
   class AiohttpRequestYarlUrlInstances extends Yarl::Url::InstanceSource {
     AiohttpRequestYarlUrlInstances() {
       this.(DataFlow::AttrRead).getObject() = Request::instance() and
diff --git a/python/ql/src/semmle/python/frameworks/Yarl.qll b/python/ql/src/semmle/python/frameworks/Yarl.qll
@@ -111,6 +111,7 @@ module Yarl {
       }
     }
 
+    /** An attribute read on a `yarl.URL` that is a `MultiDictProxy` instance. */
     class YarlUrlMultiDictProxyInstance extends Multidict::MultiDictProxy::InstanceSource {
       YarlUrlMultiDictProxyInstance() {
         this.(DataFlow::AttrRead).getObject() = Yarl::Url::instance() and

Original file line number	Diff line number	Diff line change
`@@ -328,6 +328,10 @@ module AiohttpWebModel {`
`328`	`328`	`override string getSourceType() { result = "aiohttp.web.Request" }`
`329`	`329`	`}`
`330`	`330`
	`331`	`+ /**`
	`332`	+ * A read of the `request` attribute on an instance of a aiohttp.web View class,
	`333`	`+ * which is the request being processed currently.`
	`334`	`+ */`
`331`	`335`	`class AiohttpViewClassRequestAttributeRead extends Request::InstanceSource,`
`332`	`336`	`RemoteFlowSource::Range, DataFlow::Node {`
`333`	`337`	`AiohttpViewClassRequestAttributeRead() {`
`@@ -378,13 +382,15 @@ module AiohttpWebModel {`
`378`	`382`	`}`
`379`	`383`	`}`
`380`	`384`
	`385`	+ /** An attribute read on a `aiohttp.web.Request` that is a `MultiDictProxy` instance. */
`381`	`386`	`class AiohttpRequestMultiDictProxyInstances extends Multidict::MultiDictProxy::InstanceSource {`
`382`	`387`	`AiohttpRequestMultiDictProxyInstances() {`
`383`	`388`	`this.(DataFlow::AttrRead).getObject() = Request::instance() and`
`384`	`389`	`this.(DataFlow::AttrRead).getAttributeName() in ["query", "headers"]`
`385`	`390`	`}`
`386`	`391`	`}`
`387`	`392`
	`393`	+ /** An attribute read on a `aiohttp.web.Request` that is a `yarl.URL` instance. */
`388`	`394`	`class AiohttpRequestYarlUrlInstances extends Yarl::Url::InstanceSource {`
`389`	`395`	`AiohttpRequestYarlUrlInstances() {`
`390`	`396`	`this.(DataFlow::AttrRead).getObject() = Request::instance() and`
Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,7 @@ module Yarl {`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`
	`114`	+ /** An attribute read on a `yarl.URL` that is a `MultiDictProxy` instance. */
`114`	`115`	`class YarlUrlMultiDictProxyInstance extends Multidict::MultiDictProxy::InstanceSource {`
`115`	`116`	`YarlUrlMultiDictProxyInstance() {`
`116`	`117`	`this.(DataFlow::AttrRead).getObject() = Yarl::Url::instance() and`