Skip to content

Commit b9e405d

Browse files
andrewnicolsandrewnicols
committed
[docs] Remove copyright year from statements
1 parent 2591dd5 commit b9e405d

File tree

39 files changed

+163
-168
lines changed

39 files changed

+163
-168
lines changed

‎docs/apis/commonfiles/tag.php/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Here is the core libraries tag.php file for reference:
6666
* $string['tagcollection_mycollection'] = 'My tag collection';
6767
*
6868
* @package core
69-
* @copyright 2015 Marina Glancy
69+
* @copyright Marina Glancy
7070
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7171
*/
7272

‎docs/apis/commonfiles/version.php/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Here is a template for the plugin's version.php file to copy and paste:
185185

186186
/**
187187
* @package plugintype_pluginname
188-
* @copyright 2020, You Name <your@email.address>
188+
* @copyright You Name <your@email.address>
189189
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
190190
*/
191191

‎docs/apis/plugintypes/format/_examples/renderer.php

+25-26
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,36 @@
55
use moodle_page;
66

77
/**
8-
* Basic renderer for pluginname format.
9-
*
10-
* @copyright 2022 Someone <[email protected]>
11-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
12-
*/
13-
class renderer extends section_renderer {
8+
* Basic renderer for pluginname format.
9+
*
10+
* @copyright Someone <[email protected]>
11+
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
12+
*/
13+
class renderer extends section_renderer {
1414
// Override any necessary renderer method here.
15-
1615
/**
17-
* Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page.
18-
*
19-
* This method is required to enable the inplace section title editor.
20-
*
21-
* @param section_info|stdClass $section The course_section entry from DB
22-
* @param stdClass $course The course entry from DB
23-
* @return string HTML to output.
24-
*/
16+
* Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page.
17+
*
18+
* This method is required to enable the inplace section title editor.
19+
*
20+
* @param section_info|stdClass $section The course_section entry from DB
21+
* @param stdClass $course The course entry from DB
22+
* @return string HTML to output.
23+
*/
2524
public function section_title($section, $course) {
26-
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section));
25+
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section));
2726
}
2827

2928
/**
30-
* Generate the section title to be displayed on the section page, without a link.
31-
*
32-
* This method is required to enable the inplace section title editor.
33-
*
34-
* @param section_info|stdClass $section The course_section entry from DB
35-
* @param int|stdClass $course The course entry from DB
36-
* @return string HTML to output.
37-
*/
29+
* Generate the section title to be displayed on the section page, without a link.
30+
*
31+
* This method is required to enable the inplace section title editor.
32+
*
33+
* @param section_info|stdClass $section The course_section entry from DB
34+
* @param int|stdClass $course The course entry from DB
35+
* @return string HTML to output.
36+
*/
3837
public function section_title_without_link($section, $course) {
39-
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false));
40-
}
38+
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false));
4139
}
40+
}

‎docs/apis/plugintypes/theme/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ All theme options are set within the `config.php` file for the theme.
9595
* Boost config.
9696
*
9797
* @package theme_boost
98-
* @copyright 2016 Frédéric Massart
98+
* @copyright Frédéric Massart
9999
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
100100
*/
101101

‎docs/apis/subsystems/admin/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ This is an example of a settings.php file provided by a <tt>local_helloworld</tt
8686
*
8787
* @package local_helloworld
8888
* @category admin
89-
* @copyright 2020 Your Name <email@example.com>
89+
* @copyright Your Name <email@example.com>
9090
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
9191
*/
9292

‎docs/apis/subsystems/external/testing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ For example, if you have written a service function in `[componentfolder]/classe
4646
*
4747
* @package mod_kitchen
4848
* @category external
49-
* @copyright 20XX Your Name
49+
* @copyright Your Name
5050
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5151
*/
5252

‎docs/apis/subsystems/privacy/utils.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ function check_implements($component, $interface) {
140140
/**
141141
* Helper utility to perform a test export.
142142
*
143-
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
143+
* @copyright Andrew Nicols <andrew@nicols.co.uk>
144144
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
145145
*/
146146

‎docs/guides/javascript/modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Don't forget to add the built files (the ones in amd/build) to your git commits,
175175
// Standard license block omitted.
176176
/**
177177
* @module block_overview/helloworld
178-
* @copyright 2022 Someone cool
178+
* @copyright Someone cool
179179
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
180180
*/
181181

‎general/community/plugincontribution/checklist.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ See the section [Coding style#Files](../../development/policies/codingstyle/inde
132132

133133
```php
134134
/**
135-
* @copyright 2023 John Smith <john[email protected]>
136-
* @copyright based on work by 2020 Mary Stuart <mary[email protected]>
135+
* @copyright John Smith <john[email protected]>
136+
* @copyright based on work by Mary Stuart <mary[email protected]>
137137
*/
138138
```
139139

‎general/development/policies/codingstyle/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1262,7 +1262,7 @@ $myarray = [
12621262
* Long description for class (if any)...
12631263
*
12641264
* @package mod_mymodule
1265-
* @copyright 2008 Kim Bloggs
1265+
* @copyright Kim Bloggs
12661266
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
12671267
*/
12681268
class sample_class {
@@ -1572,7 +1572,7 @@ Please do not include a Copyright Year on new files.
15721572
<ValidExample>
15731573

15741574
```
1575-
@copyright 2008 Kim Bloggs
1575+
@copyright Kim Bloggs
15761576
```
15771577

15781578
</ValidExample>
@@ -1820,7 +1820,7 @@ For files containing only one artifact, the file phpdoc block is optional as lon
18201820
*
18211821
* @package mod_mymodule
18221822
* @category backup
1823-
* @copyright 2008 Kim Bloggs
1823+
* @copyright Kim Bloggs
18241824
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
18251825
*/
18261826
```
@@ -1839,7 +1839,7 @@ All classes must have a complete docblock like this:
18391839
*
18401840
* @package mod_mymodule
18411841
* @category backup
1842-
* @copyright 2008 Kim Bloggs
1842+
* @copyright Kim Bloggs
18431843
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
18441844
*/
18451845
class policy_issue {

‎versioned_docs/version-4.1/apis/commonfiles/tag.php/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Here is the core libraries tag.php file for reference:
6666
* $string['tagcollection_mycollection'] = 'My tag collection';
6767
*
6868
* @package core
69-
* @copyright 2015 Marina Glancy
69+
* @copyright Marina Glancy
7070
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7171
*/
7272

‎versioned_docs/version-4.1/apis/commonfiles/version.php/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Here is a template for the plugin's version.php file to copy and paste:
185185

186186
/**
187187
* @package plugintype_pluginname
188-
* @copyright 2020, You Name <your@email.address>
188+
* @copyright You Name <your@email.address>
189189
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
190190
*/
191191

‎versioned_docs/version-4.1/apis/plugintypes/format/_examples/renderer.php

+25-26
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,36 @@
55
use moodle_page;
66

77
/**
8-
* Basic renderer for pluginname format.
9-
*
10-
* @copyright 2022 Someone <[email protected]>
11-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
12-
*/
13-
class renderer extends section_renderer {
8+
* Basic renderer for pluginname format.
9+
*
10+
* @copyright Someone <[email protected]>
11+
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
12+
*/
13+
class renderer extends section_renderer {
1414
// Override any necessary renderer method here.
15-
1615
/**
17-
* Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page.
18-
*
19-
* This method is required to enable the inplace section title editor.
20-
*
21-
* @param section_info|stdClass $section The course_section entry from DB
22-
* @param stdClass $course The course entry from DB
23-
* @return string HTML to output.
24-
*/
16+
* Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page.
17+
*
18+
* This method is required to enable the inplace section title editor.
19+
*
20+
* @param section_info|stdClass $section The course_section entry from DB
21+
* @param stdClass $course The course entry from DB
22+
* @return string HTML to output.
23+
*/
2524
public function section_title($section, $course) {
26-
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section));
25+
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section));
2726
}
2827

2928
/**
30-
* Generate the section title to be displayed on the section page, without a link.
31-
*
32-
* This method is required to enable the inplace section title editor.
33-
*
34-
* @param section_info|stdClass $section The course_section entry from DB
35-
* @param int|stdClass $course The course entry from DB
36-
* @return string HTML to output.
37-
*/
29+
* Generate the section title to be displayed on the section page, without a link.
30+
*
31+
* This method is required to enable the inplace section title editor.
32+
*
33+
* @param section_info|stdClass $section The course_section entry from DB
34+
* @param int|stdClass $course The course entry from DB
35+
* @return string HTML to output.
36+
*/
3837
public function section_title_without_link($section, $course) {
39-
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false));
40-
}
38+
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false));
4139
}
40+
}

‎versioned_docs/version-4.1/apis/subsystems/admin/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ This is an example of a settings.php file provided by a <tt>local_helloworld</tt
8686
*
8787
* @package local_helloworld
8888
* @category admin
89-
* @copyright 2020 Your Name <email@example.com>
89+
* @copyright Your Name <email@example.com>
9090
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
9191
*/
9292

‎versioned_docs/version-4.1/apis/subsystems/external/testing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ For example, if you have written a service function in `[componentfolder]/classe
4646
*
4747
* @package mod_kitchen
4848
* @category external
49-
* @copyright 20XX Your Name
49+
* @copyright Your Name
5050
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5151
*/
5252

‎versioned_docs/version-4.1/apis/subsystems/privacy/utils.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ function check_implements($component, $interface) {
140140
/**
141141
* Helper utility to perform a test export.
142142
*
143-
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
143+
* @copyright Andrew Nicols <andrew@nicols.co.uk>
144144
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
145145
*/
146146

‎versioned_docs/version-4.1/guides/javascript/modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Don't forget to add the built files (the ones in amd/build) to your git commits,
175175
// Standard license block omitted.
176176
/**
177177
* @module block_overview/helloworld
178-
* @copyright 2022 Someone cool
178+
* @copyright Someone cool
179179
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
180180
*/
181181

‎versioned_docs/version-4.3/apis/commonfiles/tag.php/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Here is the core libraries tag.php file for reference:
6666
* $string['tagcollection_mycollection'] = 'My tag collection';
6767
*
6868
* @package core
69-
* @copyright 2015 Marina Glancy
69+
* @copyright Marina Glancy
7070
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7171
*/
7272

‎versioned_docs/version-4.3/apis/commonfiles/version.php/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Here is a template for the plugin's version.php file to copy and paste:
185185

186186
/**
187187
* @package plugintype_pluginname
188-
* @copyright 2020, You Name <your@email.address>
188+
* @copyright You Name <your@email.address>
189189
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
190190
*/
191191

‎versioned_docs/version-4.3/apis/plugintypes/format/_examples/renderer.php

+25-26
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,36 @@
55
use moodle_page;
66

77
/**
8-
* Basic renderer for pluginname format.
9-
*
10-
* @copyright 2022 Someone <[email protected]>
11-
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
12-
*/
13-
class renderer extends section_renderer {
8+
* Basic renderer for pluginname format.
9+
*
10+
* @copyright Someone <[email protected]>
11+
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
12+
*/
13+
class renderer extends section_renderer {
1414
// Override any necessary renderer method here.
15-
1615
/**
17-
* Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page.
18-
*
19-
* This method is required to enable the inplace section title editor.
20-
*
21-
* @param section_info|stdClass $section The course_section entry from DB
22-
* @param stdClass $course The course entry from DB
23-
* @return string HTML to output.
24-
*/
16+
* Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page.
17+
*
18+
* This method is required to enable the inplace section title editor.
19+
*
20+
* @param section_info|stdClass $section The course_section entry from DB
21+
* @param stdClass $course The course entry from DB
22+
* @return string HTML to output.
23+
*/
2524
public function section_title($section, $course) {
26-
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section));
25+
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section));
2726
}
2827

2928
/**
30-
* Generate the section title to be displayed on the section page, without a link.
31-
*
32-
* This method is required to enable the inplace section title editor.
33-
*
34-
* @param section_info|stdClass $section The course_section entry from DB
35-
* @param int|stdClass $course The course entry from DB
36-
* @return string HTML to output.
37-
*/
29+
* Generate the section title to be displayed on the section page, without a link.
30+
*
31+
* This method is required to enable the inplace section title editor.
32+
*
33+
* @param section_info|stdClass $section The course_section entry from DB
34+
* @param int|stdClass $course The course entry from DB
35+
* @return string HTML to output.
36+
*/
3837
public function section_title_without_link($section, $course) {
39-
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false));
40-
}
38+
return $this->render(format_base::instance($course)->inplace_editable_render_section_name($section, false));
4139
}
40+
}

‎versioned_docs/version-4.3/apis/subsystems/admin/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ This is an example of a settings.php file provided by a <tt>local_helloworld</tt
8686
*
8787
* @package local_helloworld
8888
* @category admin
89-
* @copyright 2020 Your Name <email@example.com>
89+
* @copyright Your Name <email@example.com>
9090
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
9191
*/
9292

‎versioned_docs/version-4.3/apis/subsystems/external/testing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ For example, if you have written a service function in `[componentfolder]/classe
4646
*
4747
* @package mod_kitchen
4848
* @category external
49-
* @copyright 20XX Your Name
49+
* @copyright Your Name
5050
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5151
*/
5252

‎versioned_docs/version-4.3/apis/subsystems/privacy/utils.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ function check_implements($component, $interface) {
140140
/**
141141
* Helper utility to perform a test export.
142142
*
143-
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
143+
* @copyright Andrew Nicols <andrew@nicols.co.uk>
144144
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
145145
*/
146146

0 commit comments

Comments
 (0)