From ad20c781a53ec8d6c182989182ee1135476e2ef9 Mon Sep 17 00:00:00 2001 From: Dmitriy Simushev Date: Tue, 20 May 2014 14:22:47 +0000 Subject: [PATCH] Make controllers' comments more sensible --- .../classes/Mibew/Controller/ButtonController.php | 2 +- .../Mibew/Controller/CannedMessageController.php | 15 +++++---------- .../Mibew/Controller/HistoryController.php | 8 ++++---- .../Mibew/Controller/LicenseController.php | 2 +- .../Controller/PasswordRecoveryController.php | 4 ++-- .../Mibew/Controller/StatisticsController.php | 2 +- .../Mibew/Controller/UpdatesController.php | 2 +- .../classes/Mibew/Controller/UsersController.php | 4 ++-- 8 files changed, 17 insertions(+), 22 deletions(-) diff --git a/src/mibew/libs/classes/Mibew/Controller/ButtonController.php b/src/mibew/libs/classes/Mibew/Controller/ButtonController.php index b9efbe98..a8310276 100644 --- a/src/mibew/libs/classes/Mibew/Controller/ButtonController.php +++ b/src/mibew/libs/classes/Mibew/Controller/ButtonController.php @@ -28,7 +28,7 @@ use Symfony\Component\HttpFoundation\Response; class ButtonController extends AbstractController { /** - * Generate content for "button" route. + * Returns content of the chat button. * * @param Request $request * @return string Rendered page content diff --git a/src/mibew/libs/classes/Mibew/Controller/CannedMessageController.php b/src/mibew/libs/classes/Mibew/Controller/CannedMessageController.php index fcf000c5..6c440479 100644 --- a/src/mibew/libs/classes/Mibew/Controller/CannedMessageController.php +++ b/src/mibew/libs/classes/Mibew/Controller/CannedMessageController.php @@ -26,7 +26,7 @@ use Symfony\Component\HttpFoundation\Request; class CannedMessageController extends AbstractController { /** - * Generate content for "canned_message" route. + * Generates list of available canned messages. * * @param Request $request * @return string Rendered page content @@ -108,7 +108,7 @@ class CannedMessageController extends AbstractController } /** - * Generate content for "canned_message_delete" route. + * Removes a canned message from the database. * * @param Request $request * @return string Rendered page content @@ -135,8 +135,6 @@ class CannedMessageController extends AbstractController } /** - * Handles "canned_message_add" and "canned_message_edit" routes. - * * Builds a page with form for add/edit canned message. * * @param Request $request @@ -195,12 +193,9 @@ class CannedMessageController extends AbstractController } /** - * Handles "canned_message_add_save" and "canned_message_edit_save" routes. - * - * The action processes submitting of the forms which are generated in - * "canned_message_add" and "canned_message_edit" routes (see - * {@link \Mibew\Controller\CannedMessageController::showEditForm()} for - * details). + * Processes submitting of the forms which is generated in + * {@link \Mibew\Controller\CannedMessageController::showEditFormAction()} + * method. * * @param Request $request * @return string Rendered page content diff --git a/src/mibew/libs/classes/Mibew/Controller/HistoryController.php b/src/mibew/libs/classes/Mibew/Controller/HistoryController.php index 8469dcc9..441f3759 100644 --- a/src/mibew/libs/classes/Mibew/Controller/HistoryController.php +++ b/src/mibew/libs/classes/Mibew/Controller/HistoryController.php @@ -29,7 +29,7 @@ use Symfony\Component\HttpFoundation\Request; class HistoryController extends AbstractController { /** - * Generate content for "history" route. + * Generates the main history page with search and results. * * @param Request $request * @return string Rendered page content @@ -170,7 +170,7 @@ class HistoryController extends AbstractController } /** - * Generate content for "history_thread" route. + * Generates a page with thread history (thread log). * * @param Request $request * @return string Rendered page content @@ -209,7 +209,7 @@ class HistoryController extends AbstractController } /** - * Generate content for "history_user" route. + * Generates a page with a user history. * * @param Request $request * @return string Rendered page content @@ -273,7 +273,7 @@ class HistoryController extends AbstractController } /** - * Generate content for "history_user_track" route. + * Generates a page with user tracking information. * * @param Request $request * @return string Rendered page content diff --git a/src/mibew/libs/classes/Mibew/Controller/LicenseController.php b/src/mibew/libs/classes/Mibew/Controller/LicenseController.php index 88b4acb8..8b790274 100644 --- a/src/mibew/libs/classes/Mibew/Controller/LicenseController.php +++ b/src/mibew/libs/classes/Mibew/Controller/LicenseController.php @@ -25,7 +25,7 @@ use Symfony\Component\HttpFoundation\Request; class LicenseController extends AbstractController { /** - * Generate content for "license" route. + * Generates a page with license info. * * @param Request $request * @return string Rendered page content diff --git a/src/mibew/libs/classes/Mibew/Controller/PasswordRecoveryController.php b/src/mibew/libs/classes/Mibew/Controller/PasswordRecoveryController.php index 96a1f13a..fd7c790d 100644 --- a/src/mibew/libs/classes/Mibew/Controller/PasswordRecoveryController.php +++ b/src/mibew/libs/classes/Mibew/Controller/PasswordRecoveryController.php @@ -28,7 +28,7 @@ use Symfony\Component\Routing\Generator\UrlGeneratorInterface; class PasswordRecoveryController extends AbstractController { /** - * Generate content for "password_recovery" route. + * Generates a page for the first step of password recovery process. * * @param Request $request * @return string Rendered page content @@ -113,7 +113,7 @@ class PasswordRecoveryController extends AbstractController } /** - * Generate content for "password_recovery_reset" route. + * Resets operators password and provides an ability to set the new one. * * @param Request $request * @return string Rendered page content diff --git a/src/mibew/libs/classes/Mibew/Controller/StatisticsController.php b/src/mibew/libs/classes/Mibew/Controller/StatisticsController.php index 8ea927d8..362db2a7 100644 --- a/src/mibew/libs/classes/Mibew/Controller/StatisticsController.php +++ b/src/mibew/libs/classes/Mibew/Controller/StatisticsController.php @@ -31,7 +31,7 @@ class StatisticsController extends AbstractController const TYPE_BY_OPERATOR = 'by-operator'; /** - * Generates content for "statistics" route. + * Generates a page with statistics info. * * @param Request $request * @return string Rendered page content diff --git a/src/mibew/libs/classes/Mibew/Controller/UpdatesController.php b/src/mibew/libs/classes/Mibew/Controller/UpdatesController.php index f25b52d9..34fc674e 100644 --- a/src/mibew/libs/classes/Mibew/Controller/UpdatesController.php +++ b/src/mibew/libs/classes/Mibew/Controller/UpdatesController.php @@ -25,7 +25,7 @@ use Symfony\Component\HttpFoundation\Request; class UpdatesController extends AbstractController { /** - * Generate content for "updates" route. + * Generate a page with updates list. * * @param Request $request * @return string Rendered page content diff --git a/src/mibew/libs/classes/Mibew/Controller/UsersController.php b/src/mibew/libs/classes/Mibew/Controller/UsersController.php index 51b9d6af..22ce0f20 100644 --- a/src/mibew/libs/classes/Mibew/Controller/UsersController.php +++ b/src/mibew/libs/classes/Mibew/Controller/UsersController.php @@ -28,7 +28,7 @@ use Symfony\Component\HttpFoundation\Request; class UsersController extends AbstractController { /** - * Generate content for "users" route. + * Generates a page with awaiting visitors. * * @param Request $request * @return string Rendered page content @@ -78,7 +78,7 @@ class UsersController extends AbstractController } /** - * Generate content for "users_update" route. + * Provides a gateway for client side application at awaiting visitors page. * * @param Request $request * @return string Rendered page content