Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

CONTRIB-3564 codechecker: package and other redundant phpdocs fixed

  • Loading branch information...
commit 165fa4320dd373a8753d7aeeb28d25b410ddf397 1 parent a66e8ca
@stronk7 stronk7 authored
View
3  index.php
@@ -17,8 +17,7 @@
/**
* Run the code checker from the web.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
3  locallib.php
@@ -17,8 +17,7 @@
/**
* Code checker library code.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
12 moodle/Sniffs/ControlStructures/ControlSignatureSniff.php
@@ -17,10 +17,9 @@
/**
* Verifies that control statements conform to their coding standards.
*
- * Based on Squiz_Sniffs_ControlStructures_ControlSignatureSniff.
+ * Based on {@link Squiz_Sniffs_ControlStructures_ControlSignatureSniff}.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -30,13 +29,6 @@
throw new PHP_CodeSniffer_Exception($error);
}
-
-/**
- * Verifies that control statements conform to their coding standards.
- *
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
class moodle_Sniffs_ControlStructures_ControlSignatureSniff
extends PHP_CodeSniffer_Standards_AbstractPatternSniff {
View
10 moodle/Sniffs/Files/BoilerplateCommentSniff.php
@@ -17,19 +17,11 @@
/**
* Checks that each file contains the standard GPL comment.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-
-/**
- * Checks that each file contains the standard GPL comment.
- *
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
class moodle_Sniffs_Files_BoilerplateCommentSniff implements PHP_CodeSniffer_Sniff {
protected static $comment = array(
"// This file is part of",
View
10 moodle/Sniffs/Files/LineLengthSniff.php
@@ -17,19 +17,11 @@
/**
* Checks that lines are no more than 180 chars, ideally 132.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-
-/**
- * Checks that lines are no more than 180 chars, ideally 132.
- *
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
class moodle_Sniffs_Files_LineLengthSniff extends Generic_Sniffs_Files_LineLengthSniff {
/** Constructor. */
public function __construct() {
View
15 moodle/Sniffs/NamingConventions/ValidFunctionNameSniff.php
@@ -17,8 +17,10 @@
/**
* moodle_sniffs_namingconventions_validfunctionnamesniff.
*
- * @package local
- * @subpackage codechecker
+ * Ensures method names are correct depending on whether they are public
+ * or private, and that functions are named correctly.
+ *
+ * @package local_codechecker
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -28,15 +30,6 @@
'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found');
}
-/**
- * moodle_sniffs_namingconventions_validfunctionnamesniff.
- *
- * Ensures method names are correct depending on whether they are public
- * or private, and that functions are named correctly.
- *
- * @copyright 2009 Nicolas Connault
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
class moodle_Sniffs_NamingConventions_ValidFunctionNameSniff
extends PHP_CodeSniffer_Standards_AbstractScopeSniff {
View
9 moodle/Sniffs/NamingConventions/ValidVariableNameSniff.php
@@ -17,8 +17,7 @@
/**
* Checks variable names are all lower-case, no underscores.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -28,12 +27,6 @@
throw new PHP_CodeSniffer_Exception($error);
}
-/**
- * Checks variable names are all lower-case, no underscores.
- *
- * @copyright 2009 Nicolas Connault
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
class moodle_Sniffs_NamingConventions_ValidVariableNameSniff
extends PHP_CodeSniffer_Standards_AbstractVariableSniff {
View
14 moodle/Sniffs/PHP/CommentedOutCodeSniff.php
@@ -17,23 +17,11 @@
/**
* Sniff for detecting commented-out code.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-
-/**
- * Sniff for detecting commented-out code.
- *
- * Based on Squiz_Sniffs_PHP_CommentedOutCodeSniff.
- *
- * @package local
- * @subpackage codechecker
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
class moodle_Sniffs_PHP_CommentedOutCodeSniff implements PHP_CodeSniffer_Sniff {
public function __construct() {
$this->supportedTokenizers = array('PHP', 'CSS');
View
9 moodle/Sniffs/PHP/ForbiddenFunctionsSniff.php
@@ -17,8 +17,7 @@
/**
* Sniff for debugging and other functions that we don't want used in finished code.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -28,12 +27,6 @@
'Class Generic_Sniffs_PHP_ForbiddenFunctionsSniff not found');
}
-/**
- * Discourages the use of debug functions.
- *
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
class Moodle_Sniffs_PHP_ForbiddenFunctionsSniff
extends Generic_Sniffs_PHP_ForbiddenFunctionsSniff {
/** Constructor. */
View
15 moodle/Sniffs/PHP/IncludingFileSniff.php
@@ -20,24 +20,13 @@
*
* Checks that brackets surround the file being included.
*
- * @package local
- * @subpackage codechecker
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-
-/**
- * Checks that the include_once is used in conditional situations, and
- * require_once is used elsewhere.
- *
- * Checks that brackets surround the file being included.
- *
* Based on {@link PEAR_Sniffs_Files_IncludingFileSniff}.
*
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
+
class moodle_Sniffs_PHP_IncludingFileSniff implements PHP_CodeSniffer_Sniff {
public function register() {
return array(T_INCLUDE_ONCE, T_REQUIRE_ONCE, T_REQUIRE, T_INCLUDE);
View
25 moodle/Sniffs/PHP/MemberVarScopeSniff.php
@@ -18,10 +18,13 @@
* Verifies that class members have scope modifiers. Created by sam marshall,
* based on a sniff by Greg Sherwood and Marc McIntyre.
*
- * @package local
- * @subpackage codechecker
- * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
- * @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
+ * @package local_codechecker
+ * @author Greg Sherwood <gsherwood@squiz.net>
+ * @author Marc McIntyre <mmcintyre@squiz.net>
+ * @author sam marshall <s.marshall@open.ac.uk>
+ * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @copyright 2011 The Open University
+ * @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
*/
@@ -30,20 +33,6 @@
'Class PHP_CodeSniffer_Standards_AbstractVariableSniff not found');
}
-/**
- * Verifies that class members have scope modifiers.
- *
- * @category PHP
- * @package PHP_CodeSniffer
- * @author Greg Sherwood <gsherwood@squiz.net>
- * @author Marc McIntyre <mmcintyre@squiz.net>
- * @author sam marshall <s.marshall@open.ac.uk>
- * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
- * @copyright 2011 The Open University
- * @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
- * @version Release: 1.3.0
- * @link http://pear.php.net/package/PHP_CodeSniffer
- */
class moodle_Sniffs_PHP_MemberVarScopeSniff
extends PHP_CodeSniffer_Standards_AbstractVariableSniff {
View
10 moodle/Sniffs/WhiteSpace/SpaceAfterCommaSniff.php
@@ -17,19 +17,11 @@
/**
* Verify there is a single space after a comma.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-
-/**
- * Verify there is a single space after a comma.
- *
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
class moodle_Sniffs_WhiteSpace_SpaceAfterCommaSniff implements PHP_CodeSniffer_Sniff {
public function register() {
return array(T_COMMA);
View
9 moodle/Sniffs/WhiteSpace/WhiteSpaceInStringsSniff.php
@@ -17,18 +17,11 @@
/**
* Checks that each string does not have extra whitespace at end of line
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-/**
- * Checks that each string does not have extra whitespace at end of line
- *
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
class moodle_Sniffs_WhiteSpace_WhiteSpaceInStringsSniff implements PHP_CodeSniffer_Sniff {
/**
View
3  renderer.php
@@ -17,8 +17,7 @@
/**
* Code checker renderers.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
3  run.php
@@ -17,8 +17,7 @@
/**
* Run the code checker from the command-line.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
3  settings.php
@@ -17,8 +17,7 @@
/**
* Add page to admin menu.
*
- * @package local
- * @subpackage codechecker
+ * @package local_codechecker
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
Please sign in to comment.
Something went wrong with that request. Please try again.