Make controllers' comments more sensible

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

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.
+     * Processes submitting of the forms which is generated in
-     *
+     * {@link \Mibew\Controller\CannedMessageController::showEditFormAction()}
-     * The action processes submitting of the forms which are generated in
+     * method.
-     * "canned_message_add" and "canned_message_edit" routes (see
-     * {@link \Mibew\Controller\CannedMessageController::showEditForm()} for
-     * details).
      *
      * @param Request $request
      * @return string Rendered page content

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

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

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

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

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

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