]> git.mxchange.org Git - friendica.git/blobdiff - src/Console/DocBloxErrorChecker.php
bump version 2023.12
[friendica.git] / src / Console / DocBloxErrorChecker.php
index 88c08666cac9d2ed91094dbae8421f80cfabe8ca..7028de8a1355103f34cc77e6d68b588bec7ea93c 100644 (file)
@@ -1,4 +1,23 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Console;
 
@@ -11,7 +30,7 @@ use Friendica\App;
  *
  * Basically, docblox takes a list of files to build documentation from. This script assumes there is a file or set of files
  * breaking the build when it is included in that list. It tries to calculate the smallest list containing these files.
- * Unfortunatly, the original problem is NP-complete, so what the script does is a best guess only.
+ * Unfortunately, the original problem is NP-complete, so what the script does is a best guess only.
  *
  * So it starts with a list of all files in the project.
  * If that list can't be build, it cuts it in two parts and tries both parts independently. If only one of them breaks,
@@ -22,9 +41,6 @@ use Friendica\App;
  * After that, the script tries to remove a file from the list. It tests if the list breaks and if so, it
  * assumes that the file it removed belongs to the set of erroneous files.
  * This is done for all files, so, in the end removing one file leads to a working doc build.
- *
- * @author Alexander Kampmann
- * @author Hypolite Petovan <hypolite@mrpetovan.com>
  */
 class DocBloxErrorChecker extends \Asika\SimpleConsole\Console
 {
@@ -55,7 +71,7 @@ HELP;
                return $help;
        }
 
-       protected function doExecute()
+       protected function doExecute(): int
        {
                if ($this->getOption('v')) {
                        $this->out('Class: ' . __CLASS__);