Skip to content

Commit be01b7f

Browse files
daniil-bergdaniil-berg
committed
chore: do some cleanup and standardize phpdoc blocks
- Reword/reformat a few documentation sections. - Fix some minor mistakes. - Remove `get_qualified_name_sql` method from manager. - Add a few `@link` tags. - Use `@link` instead of `@see` in some cases. - Use `https://` in `@license` references.
1 parent 4aae283 commit be01b7f

67 files changed

Lines changed: 198 additions & 199 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎classes/event/metric_config_updated.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\event;
@@ -41,7 +41,7 @@
4141
* Sebastian Rupp <sr@artcodix.com>
4242
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
4343
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
44-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4545
*/
4646
class metric_config_updated extends metric_event {
4747
/**

‎classes/event/metric_disabled.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\event;
@@ -41,7 +41,7 @@
4141
* Sebastian Rupp <sr@artcodix.com>
4242
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
4343
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
44-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4545
*/
4646
class metric_disabled extends metric_event {
4747
/**

‎classes/event/metric_enabled.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\event;
@@ -41,7 +41,7 @@
4141
* Sebastian Rupp <sr@artcodix.com>
4242
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
4343
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
44-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4545
*/
4646
class metric_enabled extends metric_event {
4747
/**

‎classes/event/metric_event.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\event;
@@ -49,7 +49,7 @@
4949
* Sebastian Rupp <sr@artcodix.com>
5050
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
5151
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
52-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
52+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5353
*/
5454
abstract class metric_event extends base {
5555
#[\Override]

‎classes/exceptions/form_data_value_missing.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\exceptions;
@@ -39,7 +39,7 @@
3939
* Sebastian Rupp <sr@artcodix.com>
4040
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
4141
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
42-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4343
*/
4444
class form_data_value_missing extends tool_monitoring_exception {
4545
/**

‎classes/exceptions/json_invalid.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\exceptions;
@@ -39,7 +39,7 @@
3939
* Sebastian Rupp <sr@artcodix.com>
4040
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
4141
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
42-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4343
*
4444
* @phpcs:disable Squiz.WhiteSpace.ScopeClosingBrace
4545
*/

‎classes/exceptions/json_key_missing.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\exceptions;
@@ -39,7 +39,7 @@
3939
* Sebastian Rupp <sr@artcodix.com>
4040
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
4141
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
42-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4343
*/
4444
class json_key_missing extends tool_monitoring_exception {
4545
/**

‎classes/exceptions/metric_config_not_implemented.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\exceptions;
@@ -41,7 +41,7 @@
4141
* Sebastian Rupp <sr@artcodix.com>
4242
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
4343
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
44-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4545
*/
4646
class metric_config_not_implemented extends tool_monitoring_exception {
4747
/**

‎classes/exceptions/simple_metric_config_constructor_missing.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\exceptions;
@@ -41,7 +41,7 @@
4141
* Sebastian Rupp <sr@artcodix.com>
4242
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
4343
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
44-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4545
*/
4646
class simple_metric_config_constructor_missing extends tool_monitoring_exception {
4747
/**

‎classes/exceptions/tag_not_found.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Sebastian Rupp <sr@artcodix.com>
2525
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
2626
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
27-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2828
*/
2929

3030
namespace tool_monitoring\exceptions;
@@ -39,7 +39,7 @@
3939
* Sebastian Rupp <sr@artcodix.com>
4040
* Malte Schmitz <mal.schmitz@uni-luebeck.de>
4141
* Melanie Treitinger <melanie.treitinger@ruhr-uni-bochum.de>
42-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4343
*/
4444
class tag_not_found extends tool_monitoring_exception {
4545
/**

0 commit comments

Comments
 (0)