[TASK] Remove doc comments (see GIT for history)

In order to streamline the code base and to reduce the amount of code that needs to be maintaned comments are removed. Thank you @authors - Reinhard Führicht <[email protected]> - Rik Willems <[email protected]> - Christian Opitz <[email protected]> - Stefan Froemken <[email protected]> - Alexander Stehlik and everyone who is involved as well! 🤖 The full file history with author names can be found at https://github.com/PHORAX/formhandler
PHORAX · Aug 5, 2017 · 4304cb5 · 4304cb5
1 parent 43f1438
commit 4304cb5
Show file tree

Hide file tree

Showing 125 changed files with 38 additions and 420 deletions.
diff --git a/Classes/Ajax/RemoveFile.php b/Classes/Ajax/RemoveFile.php
@@ -17,8 +17,6 @@
 
 /**
  * A class removing uploaded files. This class is called via AJAX.
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class RemoveFile
 {
@@ -127,4 +125,4 @@ protected function init()
             $ajaxHandler->initAjax();
         }
     }
-}
+}
diff --git a/Classes/Ajax/Submit.php b/Classes/Ajax/Submit.php
@@ -18,8 +18,6 @@
 
 /**
  * A class calling the controller and returning the form content as JSON. This class is called via AJAX.
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class Submit
 {

diff --git a/Classes/Ajax/Validate.php b/Classes/Ajax/Validate.php
@@ -18,8 +18,6 @@
 
 /**
  * A class validating a field via AJAX.
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class Validate
 {

diff --git a/Classes/AjaxHandler/AbstractAjaxHandler.php b/Classes/AjaxHandler/AbstractAjaxHandler.php
@@ -17,8 +17,6 @@
 /**
  * Abstract class for an AjaxHandler.
  * The AjaxHandler takes care of adding AJAX related markers and JS used for validation and file removal.
- *
- * @author    Reinhard Führicht <[email protected]>
  * @abstract
  */
 abstract class AbstractAjaxHandler extends \Typoheads\Formhandler\Component\AbstractClass

diff --git a/Classes/AjaxHandler/JQuery.php b/Classes/AjaxHandler/JQuery.php
@@ -17,8 +17,6 @@
 /**
  * Abstract class for an AjaxHandler.
  * The AjaxHandler takes care of adding AJAX related markers and JS used for validation and file removal.
- *
- * @author    Reinhard Führicht <[email protected]>
  * @abstract
  */
 class JQuery extends \Typoheads\Formhandler\AjaxHandler\AbstractAjaxHandler

diff --git a/Classes/Component/AbstractClass.php b/Classes/Component/AbstractClass.php
@@ -17,8 +17,6 @@
 /**
  * Abstract class for any usable Formhandler component.
  * This class defines some useful variables and a default constructor for all Formhandler components.
- *
- * @author    Reinhard Führicht <[email protected]>
  * @abstract
  */
 abstract class AbstractClass

diff --git a/Classes/Component/AbstractComponent.php b/Classes/Component/AbstractComponent.php
@@ -17,8 +17,6 @@
 /**
  * Abstract component class for any usable Formhandler component.
  * This class extends the abstract class and adds some useful variables and methods.
- *
- * @author    Reinhard Führicht <[email protected]>
  * @abstract
  */
 abstract class AbstractComponent extends AbstractClass

diff --git a/Classes/Component/Manager.php b/Classes/Component/Manager.php
@@ -22,8 +22,6 @@
  * on code mainly written by Robert Lemke. Thanx to the FLOW3 team for all the great stuff!
  *
  * Refactored for usage with Formhandler.
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class Manager implements SingletonInterface
 {

diff --git a/Classes/Controller/AbstractController.php b/Classes/Controller/AbstractController.php
@@ -17,8 +17,6 @@
 
 /**
  * Abstract class for Controller Classes used by Formhandler.
- *
- * @author    Reinhard Führicht <[email protected]>
  * @abstract
  */
 abstract class AbstractController extends AbstractClass
@@ -60,7 +58,6 @@ abstract class AbstractController extends AbstractClass
      * Sets the content attribute of the controller
      *
      * @param Content $content
-     * @author Reinhard Führicht <[email protected]>
      * @return void
      */
     public function setContent($content)
@@ -71,7 +68,6 @@ public function setContent($content)
     /**
      * Returns the content attribute of the controller
      *
-     * @author Reinhard Führicht <[email protected]>
      * @return Content
      */
     public function getContent()
@@ -82,7 +78,6 @@ public function getContent()
     /**
      * Sets the internal attribute "predefined"
      *
-     * @author Reinhard Führicht <[email protected]>
      * @param string $key
      * @return void
      */
@@ -94,7 +89,6 @@ public function setPredefined($key)
     /**
      * Sets the internal attribute "langFile"
      *
-     * @author Reinhard Führicht <[email protected]>
      * @param array $langFiles
      * @return void
      */
@@ -105,8 +99,6 @@ public function setLangFiles($langFiles)
 
     /**
      * Sets the template file attribute to $template
-     *
-     * @author    Reinhard Führicht <[email protected]>
      * @param string $template
      * @return void
      */
@@ -118,7 +110,6 @@ public function setTemplateFile($template)
     /**
      * Returns the right settings for the formhandler (Checks if predefined form was selected)
      *
-     * @author Reinhard Führicht <[email protected]>
      * @return array The settings
      */
     public function getSettings()

diff --git a/Classes/Controller/Configuration.php b/Classes/Controller/Configuration.php
@@ -17,8 +17,6 @@
 
 /**
  * The configuration of the Formhandler
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class Configuration implements \ArrayAccess
 {

diff --git a/Classes/Controller/Content.php b/Classes/Controller/Content.php
@@ -16,8 +16,6 @@
 
 /**
  * Content to be parsed.
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class Content
 {

diff --git a/Classes/Controller/Dispatcher.php b/Classes/Controller/Dispatcher.php
@@ -17,8 +17,6 @@
 
 /**
  * The Dispatcher instantiates the Component Manager and delegates the process to the given controller.
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class Dispatcher extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin
 {

diff --git a/Classes/Controller/Form.php b/Classes/Controller/Form.php
@@ -16,8 +16,6 @@
 
 /**
  * Default controller for Formhandler
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class Form extends AbstractController
 {

diff --git a/Classes/Debugger/AbstractDebugger.php b/Classes/Debugger/AbstractDebugger.php
@@ -16,8 +16,6 @@
 
 /**
  * An abstract debugger
- *
- * @author    Reinhard Führicht <[email protected]>
  * @abstract
  */
 abstract class AbstractDebugger extends \Typoheads\Formhandler\Component\AbstractComponent

diff --git a/Classes/Debugger/DevLog.php b/Classes/Debugger/DevLog.php
@@ -16,8 +16,6 @@
 
 /**
  * A simple debugger writing messages into devlog
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class DevLog extends AbstractDebugger
 {

diff --git a/Classes/Debugger/PrintToScreen.php b/Classes/Debugger/PrintToScreen.php
@@ -16,8 +16,6 @@
 
 /**
  * A simple debugger printing the messages on the screen
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class PrintToScreen extends AbstractDebugger
 {

diff --git a/Classes/Domain/Model/Demand.php b/Classes/Domain/Model/Demand.php
@@ -16,8 +16,6 @@
 
 /**
  * Demand object for log data
- *
- * @author Reinhard Führicht <[email protected]>
  */
 class Demand extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
 {

diff --git a/Classes/Domain/Model/LogData.php b/Classes/Domain/Model/LogData.php
@@ -17,7 +17,6 @@
 /**
  * Model for log data
  *
- * @author Reinhard Führicht <[email protected]>
  */
 class LogData extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
 {

diff --git a/Classes/Domain/Repository/LogDataRepository.php b/Classes/Domain/Repository/LogDataRepository.php
@@ -17,7 +17,6 @@
 /**
  * Repository for \Typoheads\Formhandler\Domain\Model\LogData
  *
- * @author Reinhard Führicht <[email protected]>
  */
 class LogDataRepository extends \TYPO3\CMS\Extbase\Persistence\Repository
 {

diff --git a/Classes/Finisher/AbstractFinisher.php b/Classes/Finisher/AbstractFinisher.php
@@ -16,8 +16,6 @@
 
 /**
  * Abstract class for Finisher Classes used by Formhandler
- *
- * @author    Reinhard Führicht <[email protected]>
  * @abstract
  */
 abstract class AbstractFinisher extends \Typoheads\Formhandler\Component\AbstractComponent

diff --git a/Classes/Finisher/ClearCache.php b/Classes/Finisher/ClearCache.php
@@ -31,8 +31,6 @@
  * finishers.1.config.pidList = TEXT
  * finishers.1.config.pidList.data = GP:someparameter
  * </code>
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class ClearCache extends AbstractFinisher
 {

diff --git a/Classes/Finisher/DB.php b/Classes/Finisher/DB.php
@@ -54,8 +54,6 @@
  * finishers.1.config.fields.tstamp.special = sub_tstamp
  * finishers.1.config.fields.imagecaption.special = ip
  * </code>
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class DB extends AbstractFinisher
 {

diff --git a/Classes/Finisher/DifferentDB.php b/Classes/Finisher/DifferentDB.php
@@ -32,8 +32,6 @@
  * </code>
  *
  * Further configuration equals the configuration of Finisher\DB.
- *
- * @author    Reinhard Führicht <[email protected]>
  * @see \Typoheads\Formhandler\Finisher\DB
  */
 class DifferentDB extends DB

diff --git a/Classes/Finisher/GenerateAuthCode.php b/Classes/Finisher/GenerateAuthCode.php
@@ -17,8 +17,6 @@
 /**
  * This finisher generates a unique code for a database entry.
  * This can be used for FE user registration or newsletter registration.
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class GenerateAuthCode extends AbstractFinisher
 {

diff --git a/Classes/Finisher/Mail.php b/Classes/Finisher/Mail.php
@@ -63,8 +63,6 @@
  * finishers.2.config.html = MyContactForm_
  * finishers.2.config.pdf = MyContactFormPDF_
  * </code>
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class Mail extends AbstractFinisher
 {

diff --git a/Classes/Finisher/Redirect.php b/Classes/Finisher/Redirect.php
@@ -24,8 +24,6 @@
  * finishers.4.class = Finisher_Redirect
  * finishers.4.config.redirectPage = 65
  * </code>
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class Redirect extends AbstractFinisher
 {

diff --git a/Classes/Finisher/RestoreLanguage.php b/Classes/Finisher/RestoreLanguage.php
@@ -17,8 +17,6 @@
 /**
  * Finisher to restore the currently used language to the original one.
  * Only useful if the language got set using Finisher_SetLanguage before.
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class RestoreLanguage extends AbstractFinisher
 {

diff --git a/Classes/Finisher/SetLanguage.php b/Classes/Finisher/SetLanguage.php
@@ -17,8 +17,6 @@
 /**
  * Finisher to set the currently used language to a set value.
  * Useful if you want to send the admin email in a specific language and do not want to use the language of the user.
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class SetLanguage extends AbstractFinisher
 {

diff --git a/Classes/Finisher/StoreUploadedFiles.php b/Classes/Finisher/StoreUploadedFiles.php
@@ -29,8 +29,6 @@
  * finishers.1.config.schemeMarkers.marker2 = TEXT
  * finishers.1.config.schemeMarkers.marker2.value = Textvalue
  * </code>
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class StoreUploadedFiles extends AbstractFinisher
 {

diff --git a/Classes/Finisher/SubmittedOK.php b/Classes/Finisher/SubmittedOK.php
@@ -30,8 +30,6 @@
  * finishers.3.config.csv.class = Tx_Formhandler_Generator_Csv
  * finishers.3.config.csv.exportFields = firstname,lastname,interests
  * </code>
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class SubmittedOK extends AbstractFinisher
 {

diff --git a/Classes/Generator/AbstractGenerator.php b/Classes/Generator/AbstractGenerator.php
@@ -16,8 +16,6 @@
 
 /**
  * Abstract generator class for Formhandler
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 abstract class AbstractGenerator extends \Typoheads\Formhandler\Component\AbstractComponent
 {

diff --git a/Classes/Generator/BackendCsv.php b/Classes/Generator/BackendCsv.php
@@ -16,8 +16,6 @@
 
 /**
  * Class to generate CSV files in Backend
- *
- * @author    Reinhard Führicht <[email protected]>
  * @uses export2CSV in csv.lib.php
  */
 require_once(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('formhandler') . 'Resources/PHP/parsecsv.lib.php');

diff --git a/Classes/Generator/BackendTcPdf.php b/Classes/Generator/BackendTcPdf.php
@@ -16,10 +16,6 @@
 
 /**
  * Class to generate PDF files in Backend
- *
- * @author    Reinhard Führicht <[email protected]>
- * @package    Tx_Formhandler
- * @subpackage    Generator
  * @uses Tx_Formhandler_Template_TCPDF
  */
 class BackendTcPdf extends \Typoheads\Formhandler\Component\AbstractComponent

diff --git a/Classes/Generator/Csv.php b/Classes/Generator/Csv.php
@@ -16,8 +16,6 @@
 
 /**
  * CSV generator class for Formhandler
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 require_once(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('formhandler') . 'Resources/PHP/parsecsv.lib.php');
 

diff --git a/Classes/Generator/File.php b/Classes/Generator/File.php
@@ -16,8 +16,6 @@
 
 /**
  * Generator class for Formhandler for creating any file type
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class File extends AbstractGenerator
 {

diff --git a/Classes/Generator/PdfGenerator.php b/Classes/Generator/PdfGenerator.php
@@ -16,8 +16,6 @@
 
 /**
  * PDF generator class for Formhandler using the extension "pdf_generator2"
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class PdfGenerator extends AbstractGenerator
 {

diff --git a/Classes/Generator/PrintVersion.php b/Classes/Generator/PrintVersion.php
@@ -16,8 +16,6 @@
 
 /**
  * Generator class for Formhandler showing a print version of the SUBMITTED_OK template
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class PrintVersion extends AbstractGenerator
 {

diff --git a/Classes/Generator/TcPdf.php b/Classes/Generator/TcPdf.php
@@ -16,8 +16,6 @@
 
 /**
  * PDF generator class for Formhandler using TCPDF
- *
- * @author    Reinhard Führicht <[email protected]>
  */
 class TcPdf extends AbstractGenerator
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,8 +18,6 @@ @@
     /**
      * A class calling the controller and returning the form content as JSON. This class is called via AJAX.
-     *
-     * @author    Reinhard Führicht <[email protected]>
      */
     class Submit
     {
@@ Expand Down @@