Skip to content

Commit 4f9f41a

Browse files
committed
Ruby: rack - fix qldoc
1 parent f8140bc commit 4f9f41a

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

ruby/ql/lib/codeql/ruby/frameworks/rack/internal/App.qll

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,16 @@ module App {
9494
* proc that takes a single `env` argument and returns a rack response.
9595
*/
9696
abstract class App extends TApp {
97+
/** Gets a textual representation of this element. */
9798
string toString() { result = "Rack application" }
9899

100+
/** Gets the `DataFlow::CallableNode` that will handle requests to this app. */
99101
abstract CallNode getCall();
100102

103+
/** Gets the response returned from a request to this app. */
101104
RP::PotentialResponseNode getResponse() { result = this.getCall().getResponse() }
102105

106+
/** Gets the `env` parameter passed to this app when it handles a request. */
103107
DataFlow::ParameterNode getEnv() { result = this.getCall().getParameter(0) }
104108
}
105109

ruby/ql/lib/codeql/ruby/frameworks/rack/internal/Response.qll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ module Public {
9999
result = getHeaderValue(this, "content-type")
100100
}
101101

102+
/** Gets the headers returned with this response. */
102103
DataFlow::Node getHeaders() { result = this.(Private::PotentialResponseNode).getHeaders() }
103104

104105
// TODO: is there a sensible value for this?

0 commit comments

Comments
 (0)