Skip to content

Commit ea322df

Browse files
chore: Fix some controllers comments
1 parent 7338eb4 commit ea322df

File tree

5 files changed

+18
-13
lines changed

5 files changed

+18
-13
lines changed

src/controllers/Discovery.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ class Discovery extends BaseController
1717
* Show the discovery page
1818
*
1919
* @response 200
20+
* On success.
2021
*/
2122
public function show(Request $request): Response
2223
{

src/controllers/Pages.php

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ class Pages extends BaseController
1717
/**
1818
* Show the home page.
1919
*
20-
* @response 302 /news if connected
21-
* @response 302 /login else
22-
*
23-
* @return \Minz\Response
20+
* @response 302 /login
21+
* If the user is not connected.
22+
* @response 302 /news
23+
* If the user is connected.
2424
*/
2525
public function home(): Response
2626
{
@@ -35,11 +35,9 @@ public function home(): Response
3535
* Show the terms of service.
3636
*
3737
* @response 404
38-
* if the policies/legals.html file doesn’t exist
38+
* If the policies/legals.html file doesn’t exist.
3939
* @response 200
40-
* on success
41-
*
42-
* @return \Minz\Response
40+
* On success.
4341
*/
4442
public function terms(): Response
4543
{
@@ -59,6 +57,7 @@ public function terms(): Response
5957
* Show the addons page.
6058
*
6159
* @response 200
60+
* On success.
6261
*/
6362
public function addons(Request $request): Response
6463
{
@@ -69,6 +68,7 @@ public function addons(Request $request): Response
6968
* Show the about page.
7069
*
7170
* @response 200
71+
* On success.
7272
*/
7373
public function about(): Response
7474
{
@@ -81,6 +81,7 @@ public function about(): Response
8181
* Show the robots page.
8282
*
8383
* @response 200
84+
* On success.
8485
*/
8586
public function robots(): Response
8687
{
@@ -93,6 +94,7 @@ public function robots(): Response
9394
* Show the webmanifest page.
9495
*
9596
* @response 200
97+
* On success.
9698
*/
9799
public function webmanifest(): Response
98100
{

src/controllers/Sessions.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ class Sessions extends BaseController
2525
* @response 302 :redirect_to
2626
* If the user is already connected.
2727
* @response 200
28+
* On success.
2829
*/
2930
public function new(Request $request): Response
3031
{

src/controllers/Showcases.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ class Showcases extends BaseController
1919
*
2020
* @request_param string id
2121
*
22-
* @response 404 If the id doesn’t exist
23-
* @response 200 On success
22+
* @response 404
23+
* If the id doesn’t exist.
24+
* @response 200
25+
* On success.
2426
*/
2527
public function show(Request $request): Response
2628
{

src/controllers/WellKnown.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,12 @@
1111
class WellKnown extends BaseController
1212
{
1313
/**
14-
* Redirect to the change password page
14+
* Redirect to the change password page.
1515
*
1616
* @see https://w3c.github.io/webappsec-change-password-url/
1717
*
1818
* @response 302 /my/security
19-
*
20-
* @return \Minz\Response
19+
* On success.
2120
*/
2221
public function changePassword(): Response
2322
{

0 commit comments

Comments
 (0)