Merge pull request #97 from noplanman/some_code_cleanup

Just inherit repeating documentation blocks

src/Admin/ChatsCommand.php

@@ -20,47 +20,16 @@ use Longman\TelegramBot\Request;
  */
 class ChatsCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'chats';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'List all chats stored by the bot';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/chats';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
-
-    /**
-     * If this command is public
-     *
-     * @var boolean
-     */
     protected $public = true;
-
-    /**
-     * If this command needs mysql
-     *
-     * @var boolean
-     */
     protected $need_mysql = false;
+    /**#@-*/
 
     /**
      * Execution if MySQL is required but not available

src/Admin/SendtoallCommand.php

@@ -18,47 +18,16 @@ use Longman\TelegramBot\Request;
  */
 class SendtoallCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'sendtoall';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Send the message to all the user\'s bot';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/sendall <message to send>';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.2.0';
-
-    /**
-     * If this command is public
-     *
-     * @var boolean
-     */
     protected $public = true;
-
-    /**
-     * If this command needs mysql
-     *
-     * @var boolean
-     */
     protected $need_mysql = true;
+    /**#@-*/
 
     /**
      * Execution if MySQL is required but not available

src/Admin/SendtochannelCommand.php

@@ -18,47 +18,16 @@ use Longman\TelegramBot\Request;
  */
 class SendtochannelCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'sendtochannel';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Send message to a channel';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/sendchannel <message to send>';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '0.1.0';
-
-    /**
-     * If this command is public
-     *
-     * @var boolean
-     */
     protected $public = true;
-
-    /**
-     * If this command needs mysql
-     *
-     * @var boolean
-     */
     protected $need_mysql = false;
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/ChannelchatcreatedCommand.php

@@ -17,26 +17,13 @@ use Longman\TelegramBot\Command;
  */
 class ChannelchatcreatedCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'Channelchatcreated';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Channel chat created';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/ChoseninlineresultCommand.php

@@ -17,26 +17,13 @@ use Longman\TelegramBot\Command;
  */
 class ChoseninlineresultCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'choseninlineresult';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Chosen result query';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/DateCommand.php

@@ -19,40 +19,15 @@ use Longman\TelegramBot\Request;
  */
 class DateCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'date';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Show date/time by location';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/date <location>';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.2.0';
-
-    /**
-     * If this command is public
-     *
-     * @var boolean
-     */
     protected $public = true;
+    /**#@-*/
 
     /**
      * Base URL for Google Maps API

src/Commands/DeletechatphotoCommand.php

@@ -17,26 +17,13 @@ use Longman\TelegramBot\Command;
  */
 class DeletechatphotoCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'Deletechatphoto';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Delete chat photo';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/EchoCommand.php

@@ -18,40 +18,15 @@ use Longman\TelegramBot\Request;
  */
 class EchoCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'echo';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Show text';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/echo <text>';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
-
-    /**
-     * If this command is public
-     *
-     * @var boolean
-     */
     protected $public = true;
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/GenericCommand.php

@@ -18,26 +18,13 @@ use Longman\TelegramBot\Request;
  */
 class GenericCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'Generic';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Handles generic commands or is executed by default when a command is not found';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/GenericmessageCommand.php

@@ -17,26 +17,13 @@ use Longman\TelegramBot\Command;
  */
 class GenericmessageCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'Genericmessage';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Handle generic message';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/GroupchatcreatedCommand.php

@@ -17,26 +17,13 @@ use Longman\TelegramBot\Command;
  */
 class GroupchatcreatedCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'Groupchatcreated';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Group chat created';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/HelpCommand.php

@@ -18,40 +18,15 @@ use Longman\TelegramBot\Request;
  */
 class HelpCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'help';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Show bot commands help';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/help or /help <command>';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
-
-    /**
-     * If this command is public
-     *
-     * @var boolean
-     */
     protected $public = true;
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/InlinequeryCommand.php

@@ -19,26 +19,13 @@ use Longman\TelegramBot\Request;
  */
 class InlinequeryCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'inlinequery';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Reply to inline query';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/LeftchatparticipantCommand.php

@@ -17,26 +17,13 @@ use Longman\TelegramBot\Command;
  */
 class LeftchatparticipantCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'leftchatparticipant';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Left Chat Participant';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/NewchatparticipantCommand.php

@@ -18,26 +18,13 @@ use Longman\TelegramBot\Request;
  */
 class NewchatparticipantCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'Newchatparticipant';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'New Chat Participant';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/NewchattitleCommand.php

@@ -17,26 +17,13 @@ use Longman\TelegramBot\Command;
  */
 class NewchattitleCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'Newchattitle';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'New chat Title';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/SlapCommand.php

@@ -18,33 +18,14 @@ use Longman\TelegramBot\Request;
  */
 class SlapCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'slap';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Slap someone with their username';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/slap <@user>';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/StartCommand.php

@@ -18,33 +18,14 @@ use Longman\TelegramBot\Request;
  */
 class StartCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'start';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Start command';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/SupergroupchatcreatedCommand.php

@@ -18,26 +18,13 @@ use Longman\TelegramBot\Request;
  */
 class SupergroupchatcreatedCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'Supergroupchatcreated';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Super group chat created';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
+    /**#@-*/
 
     /**
      * Execute command

src/Commands/WeatherCommand.php

@@ -18,40 +18,15 @@ use Longman\TelegramBot\Request;
  */
 class WeatherCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'weather';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Show weather by location';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/weather <location>';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
-
-    /**
-     * If this command is public
-     *
-     * @var boolean
-     */
     protected $public = true;
+    /**#@-*/
 
     /**
      * Get weather using cURL request

src/Commands/WhoamiCommand.php

@@ -21,40 +21,15 @@ use Longman\TelegramBot\Request;
  */
 class WhoamiCommand extends Command
 {
-    /**
-     * Name
-     *
-     * @var string
+    /**#@+
+     * {@inheritdoc}
      */
     protected $name = 'whoami';
-
-    /**
-     * Description
-     *
-     * @var string
-     */
     protected $description = 'Show your id, name and username';
-
-    /**
-     * Usage
-     *
-     * @var string
-     */
     protected $usage = '/whoami';
-
-    /**
-     * Version
-     *
-     * @var string
-     */
     protected $version = '1.0.0';
-
-    /**
-     * If this command is public
-     *
-     * @var boolean
-     */
     protected $public = true;
+    /**#@-*/
 
     /**
      * Execute command