Skip to content

Commit 8e83de1

Browse files
formatting and grammar corrections from code review
Co-authored-by: Anders Schack-Mulligen <[email protected]>
1 parent 0f7f465 commit 8e83de1

File tree

1 file changed

+12
-12
lines changed
  • java/ql/src/semmle/code/java/frameworks/play

1 file changed

+12
-12
lines changed

java/ql/src/semmle/code/java/frameworks/play/Play.qll

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ class PlayController extends Class {
8181
* Example - class gets `index` and `login` as valid action methods.
8282
* ```java
8383
* public class Application extends Controller {
84-
* public Result index(String username, String password) {
84+
* public Result index(String username, String password) {
8585
* return ok("It works!");
8686
* }
8787
*
@@ -103,15 +103,15 @@ class PlayControllerActionMethod extends Method {
103103
}
104104

105105
/**
106-
* The PlayFramework action method parameters, these are a source of user input.
106+
* A Play framework action method parameter. These are a source of user input.
107107
*
108-
* Example - `username` & `password` are marked as valid parameters.
109-
* ```
110-
* public class Application extends Controller {
111-
* public Result index(String username, String password) {
112-
* return ok("It works!");
113-
* }
114-
* }
108+
* Example - `username` and `password` are action method parameters.
109+
* ```java
110+
* public class Application extends Controller {
111+
* public Result index(String username, String password) {
112+
* return ok("It works!");
113+
* }
114+
* }
115115
* ```
116116
*/
117117
class PlayActionMethodQueryParameter extends Parameter {
@@ -130,7 +130,7 @@ class PlayMvcHttpRequestHeaderMethods extends Method {
130130
PlayMvcHttpRequestHeaderMethods() { this.getDeclaringType() instanceof PlayMvcHttpRequestHeader }
131131

132132
/**
133-
* A reference to the `getQueryString` method.
133+
* Gets a reference to the `getQueryString` method.
134134
*/
135135
MethodAccess getAQueryStringAccess() {
136136
this.hasName("getQueryString") and result = this.getAReference()
@@ -144,12 +144,12 @@ class PlayMvcResultsMethods extends Method {
144144
PlayMvcResultsMethods() { this.getDeclaringType() instanceof PlayMvcResultsClass }
145145

146146
/**
147-
* A reference to the play.mvc.Results `ok` method.
147+
* Gets a reference to the `play.mvc.Results.ok` method.
148148
*/
149149
MethodAccess getAnOkAccess() { this.hasName("ok") and result = this.getAReference() }
150150

151151
/**
152-
* A reference to the play.mvc.Results `redirect` method.
152+
* Gets a reference to the `play.mvc.Results.redirect` method.
153153
*/
154154
MethodAccess getARedirectAccess() { this.hasName("redirect") and result = this.getAReference() }
155155
}

0 commit comments

Comments
 (0)