ci: update docs to match coding standards

catalyst · Aug 16, 2024 · ed6521e · ed6521e
1 parent 8378abe
commit ed6521e
Show file tree

Hide file tree

Showing 19 changed files with 46 additions and 24 deletions.
diff --git a/classes/local/object_manipulator/candidates/manipulator_candidates.php b/classes/local/object_manipulator/candidates/manipulator_candidates.php
@@ -14,18 +14,17 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+namespace tool_objectfs\local\object_manipulator\candidates;
+
+use dml_exception;
+
 /**
  * Interface manipulator_candidates
  * @package tool_objectfs
  * @author Gleimer Mora <gleimermora@catalyst-au.net>
  * @copyright Catalyst IT
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-
-namespace tool_objectfs\local\object_manipulator\candidates;
-
-use dml_exception;
-
 interface manipulator_candidates {
 
     /**

diff --git a/classes/local/object_manipulator/object_manipulator.php b/classes/local/object_manipulator/object_manipulator.php
@@ -14,6 +14,10 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+namespace tool_objectfs\local\object_manipulator;
+
+use stdClass;
+
 /**
  * Object manipulator interface class.
  *
@@ -22,11 +26,6 @@
  * @copyright Catalyst IT
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-
-namespace tool_objectfs\local\object_manipulator;
-
-use stdClass;
-
 interface object_manipulator {
 
 

diff --git a/classes/local/store/object_client.php b/classes/local/store/object_client.php
@@ -14,6 +14,10 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+namespace tool_objectfs\local\store;
+
+use stdClass;
+
 /**
  * Objectfs client interface.
  *
@@ -22,11 +26,6 @@
  * @copyright Catalyst IT
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-
-namespace tool_objectfs\local\store;
-
-use stdClass;
-
 interface object_client {
 
     /**

diff --git a/classes/privacy/provider.php b/classes/privacy/provider.php
@@ -13,6 +13,10 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace tool_objectfs\privacy;
+
+use core_privacy\local\metadata\null_provider;
 /**
  * Privacy provider.
  *
@@ -21,12 +25,6 @@
  * @copyright 2018 Catalyst IT
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-namespace tool_objectfs\privacy;
-use core_privacy\local\metadata\null_provider;
-/**
- * Class provider
- * @package tool_objectfs
- */
 class provider implements null_provider {
     /**
      * Get the language string identifier with the component's language

diff --git a/classes/task/objectfs_task.php b/classes/task/objectfs_task.php
@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+namespace tool_objectfs\task;
+
 /**
  * Base abstract class for objectfs tasks.
  *
@@ -22,9 +24,6 @@
  * @copyright Catalyst IT
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-
-namespace tool_objectfs\task;
-
 interface objectfs_task {
 
     /**

diff --git a/classes/tests/test_azure_integration_client.php b/classes/tests/test_azure_integration_client.php
@@ -21,6 +21,8 @@
 /**
  * [Description test_azure_integration_client]
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class test_azure_integration_client extends client {
 

diff --git a/classes/tests/test_client.php b/classes/tests/test_client.php
@@ -22,6 +22,8 @@
 /**
  * [Description test_client]
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class test_client extends object_client_base {
     /**

diff --git a/classes/tests/test_digitalocean_integration_client.php b/classes/tests/test_digitalocean_integration_client.php
@@ -21,6 +21,8 @@
 /**
  * [Description test_digitalocean_integration_client]
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class test_digitalocean_integration_client extends client {
 

diff --git a/classes/tests/test_s3_integration_client.php b/classes/tests/test_s3_integration_client.php
@@ -21,6 +21,8 @@
 /**
  * [Description test_s3_integration_client]
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class test_s3_integration_client extends client {
 

diff --git a/classes/tests/test_swift_integration_client.php b/classes/tests/test_swift_integration_client.php
@@ -21,6 +21,8 @@
 /**
  * [Description test_swift_integration_client]
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class test_swift_integration_client extends client {
 

diff --git a/classes/tests/testcase.php b/classes/tests/testcase.php
@@ -28,6 +28,8 @@
 /**
  * [Description testcase]
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class testcase extends \advanced_testcase {
     /** @var test_file_system Filesystem */

diff --git a/tests/local/object_manipulator/checker_test.php b/tests/local/object_manipulator/checker_test.php
@@ -23,6 +23,8 @@
  *
  * @covers \tool_objectfs\local\object_manipulator\checker
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class checker_test extends \tool_objectfs\tests\testcase {
 

diff --git a/tests/local/object_manipulator/deleter_test.php b/tests/local/object_manipulator/deleter_test.php
@@ -23,6 +23,8 @@
  *
  * @covers \tool_objectfs\local\object_manipulator\deleter
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class deleter_test extends \tool_objectfs\tests\testcase {
 

diff --git a/tests/local/object_manipulator/orphaner_test.php b/tests/local/object_manipulator/orphaner_test.php
@@ -24,6 +24,8 @@
  *
  * @covers \tool_objectfs\local\object_manipulator\orphaner
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class orphaner_test extends \tool_objectfs\tests\testcase {
 

diff --git a/tests/local/object_manipulator/puller_test.php b/tests/local/object_manipulator/puller_test.php
@@ -23,6 +23,8 @@
  *
  * @covers \tool_objectfs\local\object_manipulator\puller
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class puller_test extends \tool_objectfs\tests\testcase {
 

diff --git a/tests/local/object_manipulator/pusher_test.php b/tests/local/object_manipulator/pusher_test.php
@@ -24,6 +24,8 @@
  *
  * @covers \tool_objectfs\local\object_manipulator\pusher
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class pusher_test extends \tool_objectfs\tests\testcase {
 

diff --git a/tests/local/object_manipulator/recoverer_test.php b/tests/local/object_manipulator/recoverer_test.php
@@ -24,6 +24,8 @@
  *
  * @covers \tool_objectfs\local\object_manipulator\recoverer
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class recoverer_test extends \tool_objectfs\tests\testcase {
 

diff --git a/tests/local/tasks_test.php b/tests/local/tasks_test.php
@@ -21,6 +21,8 @@
  *
  * @covers \tool_objectfs\local\manager
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class tasks_test extends \tool_objectfs\tests\testcase {
 

diff --git a/tests/object_file_system_test.php b/tests/object_file_system_test.php
@@ -27,6 +27,8 @@
  *
  * @covers \tool_objectfs\local\store\object_file_system
  * @package tool_objectfs
+ * @copyright Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class object_file_system_test extends tests\testcase {