Standardize phpdocs

jeffersoncasimir · Jan 28, 2025 · 5833aca · 5833aca
1 parent ffbc5db
commit 5833aca
Show file tree

Hide file tree

Showing 7 changed files with 3 additions and 64 deletions.
diff --git a/modules/instrument_manager/php/instrument_data.class.inc b/modules/instrument_manager/php/instrument_data.class.inc
@@ -10,13 +10,7 @@ use LORIS\server_processes_manager as SP;
 /**
  * Upload instrument data
  *
- * PHP Version 8
- *
- * @category Main
- * @package  LORIS
- * @author   Loris Team <[email protected]>
- * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://www.github.com/aces/Loris/
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
  */
 class Instrument_Data extends \NDB_Page
 {

diff --git a/modules/server_processes_manager/php/parseinstrumentdataserverprocess.class.inc b/modules/server_processes_manager/php/parseinstrumentdataserverprocess.class.inc
@@ -3,24 +3,14 @@
 /**
  * This file contains code to perform a complete MRI upload on the server.
  *
- * PHP Version 5
- *
- * @category ServerProcessLauncher
- * @package  Loris
- * @author   Nicolas Brossard <[email protected]>
  * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://github.com/aces/Loris
  */
 namespace LORIS\server_processes_manager;
 
 /**
  * A class for holding a set of functions to parse large instrument data uploads
  *
- * @category ServerProcessLauncher
- * @package  Loris
- * @author   Nicolas Brossard <[email protected]>
  * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://github.com/aces/Loris
  */
 
 class ParseInstrumentDataServerProcess extends AbstractServerProcess

diff --git a/php/libraries/CSVParser.class.inc b/php/libraries/CSVParser.class.inc
@@ -3,13 +3,7 @@
 /**
  * This file contains a class used to parse csv files
  *
- * PHP Version 8
- *
- * @category Main
- * @package  LORIS
- * @author   Jefferson Casimir <[email protected]>
  * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://www.github.com/aces/Loris/
  */
 
 namespace LORIS;
@@ -20,13 +14,7 @@ use SplFileObject;
 /**
  * This class is used as a helper for parsing csv files
  *
- * PHP Version 8
- *
- * @category Main
- * @package  LORIS
- * @author   Jefferson Casimir <[email protected]>
  * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://www.github.com/aces/Loris/
  */
 class CSVParser
 {

diff --git a/php/libraries/InstrumentDataParser.class.inc b/php/libraries/InstrumentDataParser.class.inc
@@ -3,13 +3,7 @@
 /**
  * This file contains a class used to parse Instrument Data csv files
  *
- * PHP Version 8
- *
- * @category Main
- * @package  LORIS
- * @author   Jefferson Casimir <[email protected]>
  * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://www.github.com/aces/Loris/
  */
 
 namespace LORIS;
@@ -27,13 +21,7 @@ use \LORIS\Data\Dictionary\DictionaryItem as DictionaryItem;
 /**
  * This class is used to parse instrument data
  *
- * PHP Version 8
- *
- * @category Main
- * @package  LORIS
- * @author   Jefferson Casimir <[email protected]>
  * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://www.github.com/aces/Loris/
  */
 class InstrumentDataParser extends CSVParser
 {

diff --git a/test/unittests/CSVParserTest.php b/test/unittests/CSVParserTest.php
@@ -3,25 +3,15 @@
 /**
  * Unit test for CSV Parser class
  *
- * PHP Version 8
- *
- * @category Tests
- * @package  Main
- * @author   Jefferson Casimir <[email protected]>
  * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://www.github.com/aces/Loris
  */
 require_once __DIR__ . '/../../vendor/autoload.php';
 
 use PHPUnit\Framework\TestCase;
 /**
  * Unit test for CSV Parser class
  *
- * @category Tests
- * @package  Main
- * @author   Jefferson Casimir <[email protected]>
  * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://www.github.com/aces/Loris
  */
 class CSVParserTest extends TestCase
 {

diff --git a/tools/monitor_instrument_data.php b/tools/monitor_instrument_data.php
@@ -5,13 +5,7 @@
  * Checks and update status of running processes
  * Intended to be periodically run from cron
  *
- * PHP Version 8
- *
- * @category Main
- * @package  LORIS
- * @author   Loris Team <[email protected]>
  * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
- * @link     https://www.github.com/aces/Loris/
  */
 
 namespace LORIS\server_processes_manager;

diff --git a/tools/parse_instrument_data.php b/tools/parse_instrument_data.php
@@ -6,14 +6,9 @@
  * "Usage: php parse_instrument_data.php instrument fileLocation userID examinerID"
  * "Ex: php parse_instrument_data.php bmi /data/uploads/bmi_data.csv admin admin";
  *
- * PHP Version 8
- *
- * @category Main
- * @package  Loris
- * @author   Loris Team <[email protected]>
- * @license  Loris license
- * @link     https://www.github.com/aces/Loris/
+ * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
  */
+
 require_once __DIR__ . "/generic_includes.php";
 use LORIS\InstrumentDataParser;