Julian/phpbb_board3-portal_tlw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[ticket/314] Fix function and method comments

Browse Source
This commit is contained in:
Marc Alexander
2014-08-17 22:26:21 +02:00
parent ed33e19f4b
commit 39a14ea788
5 changed files with 22 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
includes/functions.php
View File

@@ -128,9 +128,11 @@ function character_limit(&$title, $limit = 0)
/** /**
* Cut post text to given length * Cut post text to given length
* *
* @param $message string post text * @param string $message post text
* @param $bbcode_uid string bbcode uid * @param string $bbcode_uid bbcode uid
* @param $length int The desired length * @param int $length The desired length
*
* @return string Shortened message
*/ */
function get_sub_taged_string($message, $bbcode_uid, $length) function get_sub_taged_string($message, $bbcode_uid, $length)
{ {

2
includes/modules_helper.php
View File

@@ -49,6 +49,7 @@ class modules_helper
* *
* @param bool $disallow_access Whether the array for disallowing access * @param bool $disallow_access Whether the array for disallowing access
* should be filled * should be filled
* @return array Array of forums the user is not allowed to access
*/ */
public function get_disallowed_forums($disallow_access) public function get_disallowed_forums($disallow_access)
{ {
@@ -123,7 +124,6 @@ class modules_helper
* Store selected forums * Store selected forums
* *
* @param string $key Key name * @param string $key Key name
* @param int $module_id Module ID
* *
* @return null * @return null
* @access public * @access public

3
migrations/v210_beta1.php
View File

@@ -530,6 +530,9 @@ class v210_beta1 extends \phpbb\db\migration\migration
/** /**
* Set config value. Creates missing config entry. * Set config value. Creates missing config entry.
* Only use this if your config value might exceed 255 characters, otherwise please use set_config * Only use this if your config value might exceed 255 characters, otherwise please use set_config
*
* @param string $config_name Name of config entry to add or update
* @param mixed $config_value Value of config entry to add or update
*/ */
private function set_portal_config($config_name, $config_value) private function set_portal_config($config_name, $config_value)
{ {

4
modules/calendar.php
View File

@@ -642,7 +642,7 @@ class calendar extends module_base
* *
* @param string $date Date to convert * @param string $date Date to convert
* *
* @return string Converted time * @return int Converted time
*/ */
protected function make_timestamp($date) protected function make_timestamp($date)
{ {
@@ -749,7 +749,7 @@ class calendar extends module_base
* date or date and time info. The string should * date or date and time info. The string should
* be in a similar format: 17.06.1990 18:06 * be in a similar format: 17.06.1990 18:06
* @return int|bool The timestamp of the given date or false if * @return int|bool The timestamp of the given date or false if
* given daten does not match any known formats. * given date does not match any known formats.
*/ */
public function date_to_time($date) public function date_to_time($date)
{ {

11
portal/fetch_posts.php
View File

@@ -119,6 +119,17 @@ class fetch_posts
/** /**
* Get posts defined by type and other settings * Get posts defined by type and other settings
* *
* @param string $forum_from Forums from which the posts should be retrieved
* @param bool $permissions Whether permissions should be taken into account
* during retrieval
* @param int $number_of_posts Number of posts to get
* @param int $text_length Length the text should be shortened to
* @param int $time The amount of days ago the posts could have been posted
* @param string $type Type of posts to get
* @param int $start At which position the query should start
* @param bool $invert Whether the permissions should be inverted
*
* @return array An array containing the posts that were retrieved from the database
*/ */
public function get_posts($forum_from, $permissions, $number_of_posts, $text_length, $time, $type, $start = 0, $invert = false) public function get_posts($forum_from, $permissions, $number_of_posts, $text_length, $time, $type, $start = 0, $invert = false)
{ {