From 2591dd56c1cad934ff3ec483988cab622d1bc454 Mon Sep 17 00:00:00 2001 From: Andrew Nicols Date: Tue, 30 Jul 2024 11:26:02 +0800 Subject: [PATCH 1/3] [docs] Clarify copyright policy for new files --- general/development/policies/codingstyle/index.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/general/development/policies/codingstyle/index.md b/general/development/policies/codingstyle/index.md index 17134c904..e727f7cd1 100644 --- a/general/development/policies/codingstyle/index.md +++ b/general/development/policies/codingstyle/index.md @@ -1557,7 +1557,17 @@ Also, there are some basic rules about how to use those types: ##### `@copyright` -These include the year and copyright holder (creator) of the original file. Do not change these in existing files! +This tag should include the copyright holder (creator) of the original file. Do not change these in existing files! + +The Copyright holder should be the real person who originally authored the file. + +:::info Use of AI + +If the file was created by an AI assistant, the copyright should be allocated to the individual who instructed the AI assistant. + +::: + +Please do not include a Copyright Year on new files. From 1a2673cf06fd0c5f8599a8ca3e6172f92d148675 Mon Sep 17 00:00:00 2001 From: Andrew Nicols Date: Tue, 30 Jul 2024 11:26:32 +0800 Subject: [PATCH 2/3] [docs] Remove copyright year from statements --- docs/apis/commonfiles/tag.php/index.md | 2 +- docs/apis/commonfiles/version.php/index.md | 2 +- docs/apis/core/reportbuilder/index.md | 2 +- .../plugintypes/format/_examples/renderer.php | 51 +++++++++---------- docs/apis/plugintypes/theme/index.md | 2 +- docs/apis/subsystems/admin/index.md | 2 +- docs/apis/subsystems/external/testing.md | 2 +- docs/apis/subsystems/privacy/utils.md | 2 +- docs/apis/subsystems/routing/parameters.md | 2 +- docs/guides/javascript/modules.md | 2 +- .../community/plugincontribution/checklist.md | 4 +- .../development/policies/codingstyle/index.md | 8 +-- .../apis/commonfiles/tag.php/index.md | 2 +- .../apis/commonfiles/version.php/index.md | 2 +- .../plugintypes/format/_examples/renderer.php | 51 +++++++++---------- .../apis/subsystems/admin/index.md | 2 +- .../apis/subsystems/external/testing.md | 2 +- .../apis/subsystems/privacy/utils.md | 2 +- .../version-4.1/guides/javascript/modules.md | 2 +- .../apis/commonfiles/tag.php/index.md | 2 +- .../apis/commonfiles/version.php/index.md | 2 +- .../apis/core/reportbuilder/index.md | 2 +- .../plugintypes/format/_examples/renderer.php | 51 +++++++++---------- .../apis/subsystems/admin/index.md | 2 +- .../apis/subsystems/external/testing.md | 2 +- .../apis/subsystems/privacy/utils.md | 2 +- .../version-4.3/guides/javascript/modules.md | 2 +- .../apis/commonfiles/tag.php/index.md | 2 +- .../apis/commonfiles/version.php/index.md | 2 +- .../apis/core/reportbuilder/index.md | 2 +- .../plugintypes/format/_examples/renderer.php | 51 +++++++++---------- .../apis/plugintypes/theme/index.md | 2 +- .../apis/subsystems/admin/index.md | 2 +- .../apis/subsystems/external/testing.md | 2 +- .../apis/subsystems/privacy/utils.md | 2 +- .../version-4.4/guides/javascript/modules.md | 2 +- .../apis/commonfiles/tag.php/index.md | 2 +- .../apis/commonfiles/version.php/index.md | 2 +- .../apis/core/reportbuilder/index.md | 2 +- .../plugintypes/format/_examples/renderer.php | 51 +++++++++---------- .../apis/plugintypes/theme/index.md | 2 +- .../apis/subsystems/admin/index.md | 2 +- .../apis/subsystems/external/testing.md | 2 +- .../apis/subsystems/privacy/utils.md | 2 +- .../apis/subsystems/routing/parameters.md | 2 +- .../version-4.5/guides/javascript/modules.md | 2 +- 46 files changed, 170 insertions(+), 175 deletions(-) diff --git a/docs/apis/commonfiles/tag.php/index.md b/docs/apis/commonfiles/tag.php/index.md index fcfd89e67..732482389 100644 --- a/docs/apis/commonfiles/tag.php/index.md +++ b/docs/apis/commonfiles/tag.php/index.md @@ -66,7 +66,7 @@ Here is the core libraries tag.php file for reference: * $string['tagcollection_mycollection'] = 'My tag collection'; * * @package core - * @copyright 2015 Marina Glancy + * @copyright Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/docs/apis/commonfiles/version.php/index.md b/docs/apis/commonfiles/version.php/index.md index f38a378b4..baf54677d 100644 --- a/docs/apis/commonfiles/version.php/index.md +++ b/docs/apis/commonfiles/version.php/index.md @@ -185,7 +185,7 @@ Here is a template for the plugin's version.php file to copy and paste: /** * @package plugintype_pluginname - * @copyright 2020, You Name + * @copyright You Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/docs/apis/core/reportbuilder/index.md b/docs/apis/core/reportbuilder/index.md index 4422ce382..2f946db3d 100644 --- a/docs/apis/core/reportbuilder/index.md +++ b/docs/apis/core/reportbuilder/index.md @@ -505,7 +505,7 @@ require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php"); * * @package core_course * @covers \core_course\reportbuilder\datasource\categories - * @copyright 2023 Paul Holden + * @copyright Paul Holden * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class categories_test extends core_reportbuilder_testcase { diff --git a/docs/apis/plugintypes/format/_examples/renderer.php b/docs/apis/plugintypes/format/_examples/renderer.php index a29a9cad9..67afde39f 100644 --- a/docs/apis/plugintypes/format/_examples/renderer.php +++ b/docs/apis/plugintypes/format/_examples/renderer.php @@ -5,37 +5,36 @@ use moodle_page; /** -* Basic renderer for pluginname format. -* -* @copyright 2022 Someone - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ - class renderer extends section_renderer { + * Basic renderer for pluginname format. + * + * @copyright Someone + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class renderer extends section_renderer { // Override any necessary renderer method here. - /** - * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); } /** - * Generate the section title to be displayed on the section page, without a link. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param int|stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title to be displayed on the section page, without a link. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param int|stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title_without_link($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); - } + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); } +} diff --git a/docs/apis/plugintypes/theme/index.md b/docs/apis/plugintypes/theme/index.md index 509f70caf..ed2541279 100644 --- a/docs/apis/plugintypes/theme/index.md +++ b/docs/apis/plugintypes/theme/index.md @@ -95,7 +95,7 @@ All theme options are set within the `config.php` file for the theme. * Boost config. * * @package theme_boost - * @copyright 2016 Frédéric Massart + * @copyright Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/docs/apis/subsystems/admin/index.md b/docs/apis/subsystems/admin/index.md index ca5e03e18..601b10b43 100644 --- a/docs/apis/subsystems/admin/index.md +++ b/docs/apis/subsystems/admin/index.md @@ -86,7 +86,7 @@ This is an example of a settings.php file provided by a local_helloworld + * @copyright Your Name * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/docs/apis/subsystems/external/testing.md b/docs/apis/subsystems/external/testing.md index 02390fbc7..f1d3dd74f 100644 --- a/docs/apis/subsystems/external/testing.md +++ b/docs/apis/subsystems/external/testing.md @@ -46,7 +46,7 @@ For example, if you have written a service function in `[componentfolder]/classe * * @package mod_kitchen * @category external - * @copyright 20XX Your Name + * @copyright Your Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/docs/apis/subsystems/privacy/utils.md b/docs/apis/subsystems/privacy/utils.md index 292d27053..bac7c59d1 100644 --- a/docs/apis/subsystems/privacy/utils.md +++ b/docs/apis/subsystems/privacy/utils.md @@ -140,7 +140,7 @@ function check_implements($component, $interface) { /** * Helper utility to perform a test export. * - * @copyright 2018 Andrew Nicols + * @copyright Andrew Nicols * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/docs/apis/subsystems/routing/parameters.md b/docs/apis/subsystems/routing/parameters.md index e8c0253f0..24b358443 100644 --- a/docs/apis/subsystems/routing/parameters.md +++ b/docs/apis/subsystems/routing/parameters.md @@ -480,7 +480,7 @@ use Psr\Http\Message\ServerRequestInterface; * A Moodle parameter referenced in the path. * * @package core - * @copyright 2023 Andrew Lyons + * @copyright Andrew Lyons * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class path_course extends \core\router\schema\parameters\path_parameter implements diff --git a/docs/guides/javascript/modules.md b/docs/guides/javascript/modules.md index 169f9d4f8..144b0873f 100644 --- a/docs/guides/javascript/modules.md +++ b/docs/guides/javascript/modules.md @@ -175,7 +175,7 @@ Don't forget to add the built files (the ones in amd/build) to your git commits, // Standard license block omitted. /** * @module block_overview/helloworld - * @copyright 2022 Someone cool + * @copyright Someone cool * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/general/community/plugincontribution/checklist.md b/general/community/plugincontribution/checklist.md index 0d71f68c2..f978c518a 100644 --- a/general/community/plugincontribution/checklist.md +++ b/general/community/plugincontribution/checklist.md @@ -132,8 +132,8 @@ See the section [Coding style#Files](../../development/policies/codingstyle/inde ```php /** - * @copyright 2023 John Smith - * @copyright based on work by 2020 Mary Stuart + * @copyright John Smith + * @copyright based on work by Mary Stuart */ ``` diff --git a/general/development/policies/codingstyle/index.md b/general/development/policies/codingstyle/index.md index e727f7cd1..c9239aaa5 100644 --- a/general/development/policies/codingstyle/index.md +++ b/general/development/policies/codingstyle/index.md @@ -1262,7 +1262,7 @@ $myarray = [ * Long description for class (if any)... * * @package mod_mymodule - * @copyright 2008 Kim Bloggs + * @copyright Kim Bloggs * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class sample_class { @@ -1572,7 +1572,7 @@ Please do not include a Copyright Year on new files. ``` - @copyright 2008 Kim Bloggs + @copyright Kim Bloggs ``` @@ -1820,7 +1820,7 @@ For files containing only one artifact, the file phpdoc block is optional as lon * * @package mod_mymodule * @category backup - * @copyright 2008 Kim Bloggs + * @copyright Kim Bloggs * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ ``` @@ -1839,7 +1839,7 @@ All classes must have a complete docblock like this: * * @package mod_mymodule * @category backup - * @copyright 2008 Kim Bloggs + * @copyright Kim Bloggs * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class policy_issue { diff --git a/versioned_docs/version-4.1/apis/commonfiles/tag.php/index.md b/versioned_docs/version-4.1/apis/commonfiles/tag.php/index.md index fcfd89e67..732482389 100644 --- a/versioned_docs/version-4.1/apis/commonfiles/tag.php/index.md +++ b/versioned_docs/version-4.1/apis/commonfiles/tag.php/index.md @@ -66,7 +66,7 @@ Here is the core libraries tag.php file for reference: * $string['tagcollection_mycollection'] = 'My tag collection'; * * @package core - * @copyright 2015 Marina Glancy + * @copyright Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.1/apis/commonfiles/version.php/index.md b/versioned_docs/version-4.1/apis/commonfiles/version.php/index.md index f38a378b4..baf54677d 100644 --- a/versioned_docs/version-4.1/apis/commonfiles/version.php/index.md +++ b/versioned_docs/version-4.1/apis/commonfiles/version.php/index.md @@ -185,7 +185,7 @@ Here is a template for the plugin's version.php file to copy and paste: /** * @package plugintype_pluginname - * @copyright 2020, You Name + * @copyright You Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.1/apis/plugintypes/format/_examples/renderer.php b/versioned_docs/version-4.1/apis/plugintypes/format/_examples/renderer.php index a29a9cad9..67afde39f 100644 --- a/versioned_docs/version-4.1/apis/plugintypes/format/_examples/renderer.php +++ b/versioned_docs/version-4.1/apis/plugintypes/format/_examples/renderer.php @@ -5,37 +5,36 @@ use moodle_page; /** -* Basic renderer for pluginname format. -* -* @copyright 2022 Someone - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ - class renderer extends section_renderer { + * Basic renderer for pluginname format. + * + * @copyright Someone + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class renderer extends section_renderer { // Override any necessary renderer method here. - /** - * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); } /** - * Generate the section title to be displayed on the section page, without a link. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param int|stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title to be displayed on the section page, without a link. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param int|stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title_without_link($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); - } + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); } +} diff --git a/versioned_docs/version-4.1/apis/subsystems/admin/index.md b/versioned_docs/version-4.1/apis/subsystems/admin/index.md index ca5e03e18..601b10b43 100644 --- a/versioned_docs/version-4.1/apis/subsystems/admin/index.md +++ b/versioned_docs/version-4.1/apis/subsystems/admin/index.md @@ -86,7 +86,7 @@ This is an example of a settings.php file provided by a local_helloworld + * @copyright Your Name * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.1/apis/subsystems/external/testing.md b/versioned_docs/version-4.1/apis/subsystems/external/testing.md index e1f4f6e85..86596c0ce 100644 --- a/versioned_docs/version-4.1/apis/subsystems/external/testing.md +++ b/versioned_docs/version-4.1/apis/subsystems/external/testing.md @@ -46,7 +46,7 @@ For example, if you have written a service function in `[componentfolder]/classe * * @package mod_kitchen * @category external - * @copyright 20XX Your Name + * @copyright Your Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.1/apis/subsystems/privacy/utils.md b/versioned_docs/version-4.1/apis/subsystems/privacy/utils.md index 292d27053..bac7c59d1 100644 --- a/versioned_docs/version-4.1/apis/subsystems/privacy/utils.md +++ b/versioned_docs/version-4.1/apis/subsystems/privacy/utils.md @@ -140,7 +140,7 @@ function check_implements($component, $interface) { /** * Helper utility to perform a test export. * - * @copyright 2018 Andrew Nicols + * @copyright Andrew Nicols * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.1/guides/javascript/modules.md b/versioned_docs/version-4.1/guides/javascript/modules.md index b338b7c1c..bb0efa606 100644 --- a/versioned_docs/version-4.1/guides/javascript/modules.md +++ b/versioned_docs/version-4.1/guides/javascript/modules.md @@ -175,7 +175,7 @@ Don't forget to add the built files (the ones in amd/build) to your git commits, // Standard license block omitted. /** * @module block_overview/helloworld - * @copyright 2022 Someone cool + * @copyright Someone cool * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.3/apis/commonfiles/tag.php/index.md b/versioned_docs/version-4.3/apis/commonfiles/tag.php/index.md index fcfd89e67..732482389 100644 --- a/versioned_docs/version-4.3/apis/commonfiles/tag.php/index.md +++ b/versioned_docs/version-4.3/apis/commonfiles/tag.php/index.md @@ -66,7 +66,7 @@ Here is the core libraries tag.php file for reference: * $string['tagcollection_mycollection'] = 'My tag collection'; * * @package core - * @copyright 2015 Marina Glancy + * @copyright Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.3/apis/commonfiles/version.php/index.md b/versioned_docs/version-4.3/apis/commonfiles/version.php/index.md index f38a378b4..baf54677d 100644 --- a/versioned_docs/version-4.3/apis/commonfiles/version.php/index.md +++ b/versioned_docs/version-4.3/apis/commonfiles/version.php/index.md @@ -185,7 +185,7 @@ Here is a template for the plugin's version.php file to copy and paste: /** * @package plugintype_pluginname - * @copyright 2020, You Name + * @copyright You Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.3/apis/core/reportbuilder/index.md b/versioned_docs/version-4.3/apis/core/reportbuilder/index.md index 37950c987..16cd589f0 100644 --- a/versioned_docs/version-4.3/apis/core/reportbuilder/index.md +++ b/versioned_docs/version-4.3/apis/core/reportbuilder/index.md @@ -478,7 +478,7 @@ require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php"); * * @package core_course * @covers \core_course\reportbuilder\datasource\categories - * @copyright 2023 Paul Holden + * @copyright Paul Holden * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class categories_test extends core_reportbuilder_testcase { diff --git a/versioned_docs/version-4.3/apis/plugintypes/format/_examples/renderer.php b/versioned_docs/version-4.3/apis/plugintypes/format/_examples/renderer.php index a29a9cad9..67afde39f 100644 --- a/versioned_docs/version-4.3/apis/plugintypes/format/_examples/renderer.php +++ b/versioned_docs/version-4.3/apis/plugintypes/format/_examples/renderer.php @@ -5,37 +5,36 @@ use moodle_page; /** -* Basic renderer for pluginname format. -* -* @copyright 2022 Someone - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ - class renderer extends section_renderer { + * Basic renderer for pluginname format. + * + * @copyright Someone + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class renderer extends section_renderer { // Override any necessary renderer method here. - /** - * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); } /** - * Generate the section title to be displayed on the section page, without a link. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param int|stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title to be displayed on the section page, without a link. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param int|stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title_without_link($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); - } + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); } +} diff --git a/versioned_docs/version-4.3/apis/subsystems/admin/index.md b/versioned_docs/version-4.3/apis/subsystems/admin/index.md index ca5e03e18..601b10b43 100644 --- a/versioned_docs/version-4.3/apis/subsystems/admin/index.md +++ b/versioned_docs/version-4.3/apis/subsystems/admin/index.md @@ -86,7 +86,7 @@ This is an example of a settings.php file provided by a local_helloworld + * @copyright Your Name * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.3/apis/subsystems/external/testing.md b/versioned_docs/version-4.3/apis/subsystems/external/testing.md index 02390fbc7..f1d3dd74f 100644 --- a/versioned_docs/version-4.3/apis/subsystems/external/testing.md +++ b/versioned_docs/version-4.3/apis/subsystems/external/testing.md @@ -46,7 +46,7 @@ For example, if you have written a service function in `[componentfolder]/classe * * @package mod_kitchen * @category external - * @copyright 20XX Your Name + * @copyright Your Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.3/apis/subsystems/privacy/utils.md b/versioned_docs/version-4.3/apis/subsystems/privacy/utils.md index 292d27053..bac7c59d1 100644 --- a/versioned_docs/version-4.3/apis/subsystems/privacy/utils.md +++ b/versioned_docs/version-4.3/apis/subsystems/privacy/utils.md @@ -140,7 +140,7 @@ function check_implements($component, $interface) { /** * Helper utility to perform a test export. * - * @copyright 2018 Andrew Nicols + * @copyright Andrew Nicols * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.3/guides/javascript/modules.md b/versioned_docs/version-4.3/guides/javascript/modules.md index 7b8e72b42..d9f1a5ab8 100644 --- a/versioned_docs/version-4.3/guides/javascript/modules.md +++ b/versioned_docs/version-4.3/guides/javascript/modules.md @@ -175,7 +175,7 @@ Don't forget to add the built files (the ones in amd/build) to your git commits, // Standard license block omitted. /** * @module block_overview/helloworld - * @copyright 2022 Someone cool + * @copyright Someone cool * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.4/apis/commonfiles/tag.php/index.md b/versioned_docs/version-4.4/apis/commonfiles/tag.php/index.md index fcfd89e67..732482389 100644 --- a/versioned_docs/version-4.4/apis/commonfiles/tag.php/index.md +++ b/versioned_docs/version-4.4/apis/commonfiles/tag.php/index.md @@ -66,7 +66,7 @@ Here is the core libraries tag.php file for reference: * $string['tagcollection_mycollection'] = 'My tag collection'; * * @package core - * @copyright 2015 Marina Glancy + * @copyright Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.4/apis/commonfiles/version.php/index.md b/versioned_docs/version-4.4/apis/commonfiles/version.php/index.md index f38a378b4..baf54677d 100644 --- a/versioned_docs/version-4.4/apis/commonfiles/version.php/index.md +++ b/versioned_docs/version-4.4/apis/commonfiles/version.php/index.md @@ -185,7 +185,7 @@ Here is a template for the plugin's version.php file to copy and paste: /** * @package plugintype_pluginname - * @copyright 2020, You Name + * @copyright You Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.4/apis/core/reportbuilder/index.md b/versioned_docs/version-4.4/apis/core/reportbuilder/index.md index d7c0880de..14ba6d47f 100644 --- a/versioned_docs/version-4.4/apis/core/reportbuilder/index.md +++ b/versioned_docs/version-4.4/apis/core/reportbuilder/index.md @@ -510,7 +510,7 @@ require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php"); * * @package core_course * @covers \core_course\reportbuilder\datasource\categories - * @copyright 2023 Paul Holden + * @copyright Paul Holden * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class categories_test extends core_reportbuilder_testcase { diff --git a/versioned_docs/version-4.4/apis/plugintypes/format/_examples/renderer.php b/versioned_docs/version-4.4/apis/plugintypes/format/_examples/renderer.php index a29a9cad9..67afde39f 100644 --- a/versioned_docs/version-4.4/apis/plugintypes/format/_examples/renderer.php +++ b/versioned_docs/version-4.4/apis/plugintypes/format/_examples/renderer.php @@ -5,37 +5,36 @@ use moodle_page; /** -* Basic renderer for pluginname format. -* -* @copyright 2022 Someone - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ - class renderer extends section_renderer { + * Basic renderer for pluginname format. + * + * @copyright Someone + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class renderer extends section_renderer { // Override any necessary renderer method here. - /** - * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); } /** - * Generate the section title to be displayed on the section page, without a link. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param int|stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title to be displayed on the section page, without a link. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param int|stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title_without_link($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); - } + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); } +} diff --git a/versioned_docs/version-4.4/apis/plugintypes/theme/index.md b/versioned_docs/version-4.4/apis/plugintypes/theme/index.md index 509f70caf..ed2541279 100644 --- a/versioned_docs/version-4.4/apis/plugintypes/theme/index.md +++ b/versioned_docs/version-4.4/apis/plugintypes/theme/index.md @@ -95,7 +95,7 @@ All theme options are set within the `config.php` file for the theme. * Boost config. * * @package theme_boost - * @copyright 2016 Frédéric Massart + * @copyright Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.4/apis/subsystems/admin/index.md b/versioned_docs/version-4.4/apis/subsystems/admin/index.md index ca5e03e18..601b10b43 100644 --- a/versioned_docs/version-4.4/apis/subsystems/admin/index.md +++ b/versioned_docs/version-4.4/apis/subsystems/admin/index.md @@ -86,7 +86,7 @@ This is an example of a settings.php file provided by a local_helloworld + * @copyright Your Name * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.4/apis/subsystems/external/testing.md b/versioned_docs/version-4.4/apis/subsystems/external/testing.md index 02390fbc7..f1d3dd74f 100644 --- a/versioned_docs/version-4.4/apis/subsystems/external/testing.md +++ b/versioned_docs/version-4.4/apis/subsystems/external/testing.md @@ -46,7 +46,7 @@ For example, if you have written a service function in `[componentfolder]/classe * * @package mod_kitchen * @category external - * @copyright 20XX Your Name + * @copyright Your Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.4/apis/subsystems/privacy/utils.md b/versioned_docs/version-4.4/apis/subsystems/privacy/utils.md index 292d27053..bac7c59d1 100644 --- a/versioned_docs/version-4.4/apis/subsystems/privacy/utils.md +++ b/versioned_docs/version-4.4/apis/subsystems/privacy/utils.md @@ -140,7 +140,7 @@ function check_implements($component, $interface) { /** * Helper utility to perform a test export. * - * @copyright 2018 Andrew Nicols + * @copyright Andrew Nicols * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.4/guides/javascript/modules.md b/versioned_docs/version-4.4/guides/javascript/modules.md index 169f9d4f8..144b0873f 100644 --- a/versioned_docs/version-4.4/guides/javascript/modules.md +++ b/versioned_docs/version-4.4/guides/javascript/modules.md @@ -175,7 +175,7 @@ Don't forget to add the built files (the ones in amd/build) to your git commits, // Standard license block omitted. /** * @module block_overview/helloworld - * @copyright 2022 Someone cool + * @copyright Someone cool * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.5/apis/commonfiles/tag.php/index.md b/versioned_docs/version-4.5/apis/commonfiles/tag.php/index.md index fcfd89e67..732482389 100644 --- a/versioned_docs/version-4.5/apis/commonfiles/tag.php/index.md +++ b/versioned_docs/version-4.5/apis/commonfiles/tag.php/index.md @@ -66,7 +66,7 @@ Here is the core libraries tag.php file for reference: * $string['tagcollection_mycollection'] = 'My tag collection'; * * @package core - * @copyright 2015 Marina Glancy + * @copyright Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.5/apis/commonfiles/version.php/index.md b/versioned_docs/version-4.5/apis/commonfiles/version.php/index.md index f38a378b4..baf54677d 100644 --- a/versioned_docs/version-4.5/apis/commonfiles/version.php/index.md +++ b/versioned_docs/version-4.5/apis/commonfiles/version.php/index.md @@ -185,7 +185,7 @@ Here is a template for the plugin's version.php file to copy and paste: /** * @package plugintype_pluginname - * @copyright 2020, You Name + * @copyright You Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.5/apis/core/reportbuilder/index.md b/versioned_docs/version-4.5/apis/core/reportbuilder/index.md index 46fd4794c..0166e3806 100644 --- a/versioned_docs/version-4.5/apis/core/reportbuilder/index.md +++ b/versioned_docs/version-4.5/apis/core/reportbuilder/index.md @@ -493,7 +493,7 @@ require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php"); * * @package core_course * @covers \core_course\reportbuilder\datasource\categories - * @copyright 2023 Paul Holden + * @copyright Paul Holden * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class categories_test extends core_reportbuilder_testcase { diff --git a/versioned_docs/version-4.5/apis/plugintypes/format/_examples/renderer.php b/versioned_docs/version-4.5/apis/plugintypes/format/_examples/renderer.php index a29a9cad9..67afde39f 100644 --- a/versioned_docs/version-4.5/apis/plugintypes/format/_examples/renderer.php +++ b/versioned_docs/version-4.5/apis/plugintypes/format/_examples/renderer.php @@ -5,37 +5,36 @@ use moodle_page; /** -* Basic renderer for pluginname format. -* -* @copyright 2022 Someone - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ - class renderer extends section_renderer { + * Basic renderer for pluginname format. + * + * @copyright Someone + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class renderer extends section_renderer { // Override any necessary renderer method here. - /** - * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section)); } /** - * Generate the section title to be displayed on the section page, without a link. - * - * This method is required to enable the inplace section title editor. - * - * @param section_info|stdClass $section The course_section entry from DB - * @param int|stdClass $course The course entry from DB - * @return string HTML to output. - */ + * Generate the section title to be displayed on the section page, without a link. + * + * This method is required to enable the inplace section title editor. + * + * @param section_info|stdClass $section The course_section entry from DB + * @param int|stdClass $course The course entry from DB + * @return string HTML to output. + */ public function section_title_without_link($section, $course) { - return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); - } + return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false)); } +} diff --git a/versioned_docs/version-4.5/apis/plugintypes/theme/index.md b/versioned_docs/version-4.5/apis/plugintypes/theme/index.md index 509f70caf..ed2541279 100644 --- a/versioned_docs/version-4.5/apis/plugintypes/theme/index.md +++ b/versioned_docs/version-4.5/apis/plugintypes/theme/index.md @@ -95,7 +95,7 @@ All theme options are set within the `config.php` file for the theme. * Boost config. * * @package theme_boost - * @copyright 2016 Frédéric Massart + * @copyright Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.5/apis/subsystems/admin/index.md b/versioned_docs/version-4.5/apis/subsystems/admin/index.md index ca5e03e18..601b10b43 100644 --- a/versioned_docs/version-4.5/apis/subsystems/admin/index.md +++ b/versioned_docs/version-4.5/apis/subsystems/admin/index.md @@ -86,7 +86,7 @@ This is an example of a settings.php file provided by a local_helloworld + * @copyright Your Name * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.5/apis/subsystems/external/testing.md b/versioned_docs/version-4.5/apis/subsystems/external/testing.md index 02390fbc7..f1d3dd74f 100644 --- a/versioned_docs/version-4.5/apis/subsystems/external/testing.md +++ b/versioned_docs/version-4.5/apis/subsystems/external/testing.md @@ -46,7 +46,7 @@ For example, if you have written a service function in `[componentfolder]/classe * * @package mod_kitchen * @category external - * @copyright 20XX Your Name + * @copyright Your Name * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.5/apis/subsystems/privacy/utils.md b/versioned_docs/version-4.5/apis/subsystems/privacy/utils.md index 292d27053..bac7c59d1 100644 --- a/versioned_docs/version-4.5/apis/subsystems/privacy/utils.md +++ b/versioned_docs/version-4.5/apis/subsystems/privacy/utils.md @@ -140,7 +140,7 @@ function check_implements($component, $interface) { /** * Helper utility to perform a test export. * - * @copyright 2018 Andrew Nicols + * @copyright Andrew Nicols * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/versioned_docs/version-4.5/apis/subsystems/routing/parameters.md b/versioned_docs/version-4.5/apis/subsystems/routing/parameters.md index e8c0253f0..24b358443 100644 --- a/versioned_docs/version-4.5/apis/subsystems/routing/parameters.md +++ b/versioned_docs/version-4.5/apis/subsystems/routing/parameters.md @@ -480,7 +480,7 @@ use Psr\Http\Message\ServerRequestInterface; * A Moodle parameter referenced in the path. * * @package core - * @copyright 2023 Andrew Lyons + * @copyright Andrew Lyons * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class path_course extends \core\router\schema\parameters\path_parameter implements diff --git a/versioned_docs/version-4.5/guides/javascript/modules.md b/versioned_docs/version-4.5/guides/javascript/modules.md index 169f9d4f8..144b0873f 100644 --- a/versioned_docs/version-4.5/guides/javascript/modules.md +++ b/versioned_docs/version-4.5/guides/javascript/modules.md @@ -175,7 +175,7 @@ Don't forget to add the built files (the ones in amd/build) to your git commits, // Standard license block omitted. /** * @module block_overview/helloworld - * @copyright 2022 Someone cool + * @copyright Someone cool * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ From 51dad7794478f3c764f521d0c8784cb4b90fb9a7 Mon Sep 17 00:00:00 2001 From: Andrew Nicols Date: Tue, 30 Jul 2024 11:28:04 +0800 Subject: [PATCH 3/3] [docs] Fix internal links to some tags --- general/development/policies/codingstyle/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/general/development/policies/codingstyle/index.md b/general/development/policies/codingstyle/index.md index c9239aaa5..2b373d6de 100644 --- a/general/development/policies/codingstyle/index.md +++ b/general/development/policies/codingstyle/index.md @@ -1849,7 +1849,7 @@ class policy_issue { For files containing only one artifact (class, interface, trait, etc.), specifically for all the files within `classes` directories, but also any other file fulfilling the condition anywhere else, it will be enough with the class phpdoc block. The file phpdoc block will be considered optional at all effects, giving to the class one precedence. -The [@package](https://docs.moodle.org/dev/#@package), [@copyright](https://docs.moodle.org/dev/#@copyright) and [@license](https://docs.moodle.org/dev/#@license) tags (and the optional [@category](https://docs.moodle.org/dev/#@category) tag ), as shown in the example above, must be present always in the file (in whichever docblock, but all together). +The [@package](#package), [@copyright](#copyright) and [@license](#license) tags (and the optional [@category](#category) tag ), as shown in the example above, must be present always in the file (in whichever docblock, but all together). ### Properties