Moodle

Clean up and rationalise phpdocs and copyright statements across Moodle

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Critical Critical
  • Resolution: Fixed
  • Affects Version/s: 2.0
  • Fix Version/s: 2.0
  • Component/s: Administration
  • Labels:
    None

Description

Update phpdocs and copyright notices in files so that:

  • every file has a GPL v3 statement
  • every file has a copyright owner
  • every file has the minimal set of phpdocs tags
  • remove all the $Id$ tags

Issue Links

This issue will help resolve:
MDL-16387 provide boilerplate template for new source files Minor Closed
This issue will be resolved by:
MDL-19247 PHP CodeSniffer: tool for coding standard consistency Minor Open

Activity

Hide
Permalink
Martin Dougiamas added a comment -

Example from Coding Style docs:

<?php
 
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
 
 
/**
 * This is a one-line short description of the file
 *
 * You can have a rather longer description of the file as well,
 * if you like, and it can span multiple lines.
 *
 * @package moodlecore
 * @copyright 2008 Kim Bloggs
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
Show
Martin Dougiamas added a comment - Example from Coding Style docs: 
<?php
 
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
 
 
/**
 * This is a one-line short description of the file
 *
 * You can have a rather longer description of the file as well,
 * if you like, and it can span multiple lines.
 *
 * @package moodlecore
 * @copyright 2008 Kim Bloggs
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

People

Vote (0)
Watch (5)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Moodle. Try JIRA - bug tracking software for your team.