Merge remote-tracking branch 'p/ticket/11227' into develop

* p/ticket/11227:
  [ticket/11227] @return void -> @return null in code sniffer.
  [ticket/11227] @return void -> @return null, per coding guidelines.
This commit is contained in:
Andreas Fischer 2012-12-01 12:21:29 +01:00
commit 1ceb1f759d
19 changed files with 29 additions and 29 deletions

View file

@ -35,7 +35,7 @@ class phpbb_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff
* @param int $stackPtr The position of the current token * @param int $stackPtr The position of the current token
* in the stack passed in $tokens. * in the stack passed in $tokens.
* *
* @return void * @return null
*/ */
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{ {
@ -120,7 +120,7 @@ class phpbb_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff
* @param integer The stack pointer for the first comment token. * @param integer The stack pointer for the first comment token.
* @param array(string=>array) $tags The found file doc comment tags. * @param array(string=>array) $tags The found file doc comment tags.
* *
* @return void * @return null
*/ */
protected function processPackage(PHP_CodeSniffer_File $phpcsFile, $ptr, $tags) protected function processPackage(PHP_CodeSniffer_File $phpcsFile, $ptr, $tags)
{ {
@ -143,7 +143,7 @@ class phpbb_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff
* @param integer The stack pointer for the first comment token. * @param integer The stack pointer for the first comment token.
* @param array(string=>array) $tags The found file doc comment tags. * @param array(string=>array) $tags The found file doc comment tags.
* *
* @return void * @return null
*/ */
protected function processVersion(PHP_CodeSniffer_File $phpcsFile, $ptr, $tags) protected function processVersion(PHP_CodeSniffer_File $phpcsFile, $ptr, $tags)
{ {
@ -166,7 +166,7 @@ class phpbb_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff
* @param integer The stack pointer for the first comment token. * @param integer The stack pointer for the first comment token.
* @param array(string=>array) $tags The found file doc comment tags. * @param array(string=>array) $tags The found file doc comment tags.
* *
* @return void * @return null
*/ */
protected function processCopyright(PHP_CodeSniffer_File $phpcsFile, $ptr, $tags) protected function processCopyright(PHP_CodeSniffer_File $phpcsFile, $ptr, $tags)
{ {
@ -189,7 +189,7 @@ class phpbb_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff
* @param integer The stack pointer for the first comment token. * @param integer The stack pointer for the first comment token.
* @param array(string=>array) $tags The found file doc comment tags. * @param array(string=>array) $tags The found file doc comment tags.
* *
* @return void * @return null
*/ */
protected function processLicense(PHP_CodeSniffer_File $phpcsFile, $ptr, $tags) protected function processLicense(PHP_CodeSniffer_File $phpcsFile, $ptr, $tags)
{ {

View file

@ -109,7 +109,7 @@ class phpbb_config implements ArrayAccess, IteratorAggregate, Countable
* @param String $key The configuration option's name * @param String $key The configuration option's name
* @param bool $use_cache Whether this variable should be cached or if it * @param bool $use_cache Whether this variable should be cached or if it
* changes too frequently to be efficiently cached * changes too frequently to be efficiently cached
* @return void * @return null
*/ */
public function delete($key, $use_cache = true) public function delete($key, $use_cache = true)
{ {

View file

@ -96,7 +96,7 @@ class phpbb_config_db extends phpbb_config
* @param String $key The configuration option's name * @param String $key The configuration option's name
* @param bool $use_cache Whether this variable should be cached or if it * @param bool $use_cache Whether this variable should be cached or if it
* changes too frequently to be efficiently cached * changes too frequently to be efficiently cached
* @return void * @return null
*/ */
public function delete($key, $use_cache = true) public function delete($key, $use_cache = true)
{ {

View file

@ -54,7 +54,7 @@ class phpbb_cron_manager
* *
* @param array|Traversable $tasks Array of instances of phpbb_cron_task * @param array|Traversable $tasks Array of instances of phpbb_cron_task
* *
* @return void * @return null
*/ */
public function load_tasks($tasks) public function load_tasks($tasks)
{ {

View file

@ -50,7 +50,7 @@ class phpbb_cron_task_core_prune_all_forums extends phpbb_cron_task_base
/** /**
* Runs this cron task. * Runs this cron task.
* *
* @return void * @return null
*/ */
public function run() public function run()
{ {

View file

@ -70,7 +70,7 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
/** /**
* Runs this cron task. * Runs this cron task.
* *
* @return void * @return null
*/ */
public function run() public function run()
{ {
@ -138,7 +138,7 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
* *
* @param phpbb_request_interface $request Request object. * @param phpbb_request_interface $request Request object.
* *
* @return void * @return null
*/ */
public function parse_parameters(phpbb_request_interface $request) public function parse_parameters(phpbb_request_interface $request)
{ {

View file

@ -43,7 +43,7 @@ class phpbb_cron_task_core_queue extends phpbb_cron_task_base
/** /**
* Runs this cron task. * Runs this cron task.
* *
* @return void * @return null
*/ */
public function run() public function run()
{ {

View file

@ -40,7 +40,7 @@ class phpbb_cron_task_core_tidy_cache extends phpbb_cron_task_base
/** /**
* Runs this cron task. * Runs this cron task.
* *
* @return void * @return null
*/ */
public function run() public function run()
{ {

View file

@ -43,7 +43,7 @@ class phpbb_cron_task_core_tidy_database extends phpbb_cron_task_base
/** /**
* Runs this cron task. * Runs this cron task.
* *
* @return void * @return null
*/ */
public function run() public function run()
{ {

View file

@ -54,7 +54,7 @@ class phpbb_cron_task_core_tidy_search extends phpbb_cron_task_base
/** /**
* Runs this cron task. * Runs this cron task.
* *
* @return void * @return null
*/ */
public function run() public function run()
{ {

View file

@ -40,7 +40,7 @@ class phpbb_cron_task_core_tidy_sessions extends phpbb_cron_task_base
/** /**
* Runs this cron task. * Runs this cron task.
* *
* @return void * @return null
*/ */
public function run() public function run()
{ {

View file

@ -45,7 +45,7 @@ class phpbb_cron_task_core_tidy_warnings extends phpbb_cron_task_base
/** /**
* Runs this cron task. * Runs this cron task.
* *
* @return void * @return null
*/ */
public function run() public function run()
{ {

View file

@ -46,7 +46,7 @@ interface phpbb_cron_task_parametrized extends phpbb_cron_task
* *
* @param phpbb_request_interface $request Request object. * @param phpbb_request_interface $request Request object.
* *
* @return void * @return null
*/ */
public function parse_parameters(phpbb_request_interface $request); public function parse_parameters(phpbb_request_interface $request);
} }

View file

@ -31,7 +31,7 @@ interface phpbb_cron_task
/** /**
* Runs this cron task. * Runs this cron task.
* *
* @return void * @return null
*/ */
public function run(); public function run();

View file

@ -433,7 +433,7 @@ function set_modified_headers($stamp, $browser)
* *
* @param bool $exit Whether to die or not. * @param bool $exit Whether to die or not.
* *
* @return void * @return null
*/ */
function file_gc($exit = true) function file_gc($exit = true)
{ {

View file

@ -104,7 +104,7 @@ class phpbb_group_positions
* Addes a group by group_id * Addes a group by group_id
* *
* @param int $group_id group_id of the group to be added * @param int $group_id group_id of the group to be added
* @return void * @return null
*/ */
public function add_group($group_id) public function add_group($group_id)
{ {
@ -128,7 +128,7 @@ class phpbb_group_positions
* *
* @param int $group_id group_id of the group to be deleted * @param int $group_id group_id of the group to be deleted
* @param bool $skip_group Skip setting the group to GROUP_DISABLED, to save the query, when you need to update it anyway. * @param bool $skip_group Skip setting the group to GROUP_DISABLED, to save the query, when you need to update it anyway.
* @return void * @return null
*/ */
public function delete_group($group_id, $skip_group = false) public function delete_group($group_id, $skip_group = false)
{ {
@ -159,7 +159,7 @@ class phpbb_group_positions
* Moves a group up by group_id * Moves a group up by group_id
* *
* @param int $group_id group_id of the group to be moved * @param int $group_id group_id of the group to be moved
* @return void * @return null
*/ */
public function move_up($group_id) public function move_up($group_id)
{ {
@ -170,7 +170,7 @@ class phpbb_group_positions
* Moves a group down by group_id * Moves a group down by group_id
* *
* @param int $group_id group_id of the group to be moved * @param int $group_id group_id of the group to be moved
* @return void * @return null
*/ */
public function move_down($group_id) public function move_down($group_id)
{ {
@ -184,7 +184,7 @@ class phpbb_group_positions
* @param int $delta number of steps: * @param int $delta number of steps:
* - positive = move up * - positive = move up
* - negative = move down * - negative = move down
* @return void * @return null
*/ */
public function move($group_id, $delta) public function move($group_id, $delta)
{ {

View file

@ -125,7 +125,7 @@ class phpbb_lock_db
* Note: Attempting to release a lock that is already released, * Note: Attempting to release a lock that is already released,
* that is, calling release() multiple times, is harmless. * that is, calling release() multiple times, is harmless.
* *
* @return void * @return null
*/ */
public function release() public function release()
{ {

View file

@ -110,7 +110,7 @@ class phpbb_style_resource_locator implements phpbb_template_locator
* Typically it is one directory level deep, e.g. "template/". * Typically it is one directory level deep, e.g. "template/".
* *
* @param string $template_path Relative path to templates directory within style directories * @param string $template_path Relative path to templates directory within style directories
* @return void * @return null
*/ */
public function set_template_path($template_path) public function set_template_path($template_path)
{ {
@ -121,7 +121,7 @@ class phpbb_style_resource_locator implements phpbb_template_locator
* Sets the location of templates directory within style directories * Sets the location of templates directory within style directories
* to the default, which is "template/". * to the default, which is "template/".
* *
* @return void * @return null
*/ */
public function set_default_template_path() public function set_default_template_path()
{ {

View file

@ -118,7 +118,7 @@ class phpbb_template_compile
* *
* @param resource $source_stream Source stream * @param resource $source_stream Source stream
* @param resource $dest_stream Destination stream * @param resource $dest_stream Destination stream
* @return void * @return null
*/ */
private function compile_stream_to_stream($source_stream, $dest_stream) private function compile_stream_to_stream($source_stream, $dest_stream)
{ {