[#MDL-19235] Clean up and rationalise phpdocs and copyright statements across Moodle

Issue Details (XML | Word | Printable)

Key:	MDL-19235
Type:	Improvement
Status:	Open
Priority:	Critical
Assignee:	Sam Hemelryk
Reporter:	Martin Dougiamas
Votes:	0
Watchers:	5

Operations

Add/Edit UI Mockup to this issue

If you were logged in you would be able to see more operations.

Moodle

Clean up and rationalise phpdocs and copyright statements across Moodle

Created: 19/May/09 03:45 PM Updated: 19/May/09 11:24 PM

Return to search

Component/s:

Administration

Affects Version/s:

2.0

Fix Version/s:

2.0

Issue Links:

Dependency

This issue will help resolve:

~~MDL-16387~~ provide boilerplate template for new source files

This issue will be resolved by:

MDL-19247 PHP CodeSniffer: tool for coding standard consistency

URL:	http://docs.moodle.org/en/Development:Coding_style#Files
Participants:	Martin Dougiamas and Sam Hemelryk
Security Level:	None
QA Assignee:	Martin Dougiamas
Difficulty:	Moderate
Affected Branches:	MOODLE_20_STABLE
Fixed Branches:	MOODLE_20_STABLE

Sub-Tasks:

All

Open

Sub-Task Progress:

phpdocs and copyrights in /lib

Open

Sam Hemelryk

Description

« Hide

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

All

Comments

Change History

Version Control

Sort Order:

[ Permalink | « Hide ]

Martin Dougiamas added a comment - 19/May/09 04:13 PM

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
 */

All content on this web site is made available under the GNU General Public License, unless otherwise stated.