makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 22:28:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

some changes for proper code documentation

Browse source 
git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@8783 89ea8834-ac86-4346-8a33-228a782c2dd0
This commit is contained in:
Meik Sievertsen 2008-08-23 17:23:40 +00:00
parent d7fa3f83ce
commit 4d7b9b76fa
6 changed files with 68 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
phpBB/includes/acp/acp_styles.php
View file

@ -3382,7 +3382,7 @@ inherit_from = {INHERIT_FROM}
/** /**
* Checks downwards dependencies * Checks downwards dependencies
* *
* @visibility public * @access public
* @param string $mode The element type to check - only template is supported * @param string $mode The element type to check - only template is supported
* @param int $id The template id * @param int $id The template id
* @returns false if no component inherits, array with name, path and id for each subtemplate otherwise * @returns false if no component inherits, array with name, path and id for each subtemplate otherwise
@ -3438,7 +3438,7 @@ inherit_from = {INHERIT_FROM}
/** /**
* Checks upwards dependencies * Checks upwards dependencies
* *
* @visibility public * @access public
* @param string $mode The element type to check - only template is supported * @param string $mode The element type to check - only template is supported
* @param int $id The template id * @param int $id The template id
* @returns false if the component does not inherit, array with name, path and id otherwise * @returns false if the component does not inherit, array with name, path and id otherwise
@ -3498,7 +3498,7 @@ inherit_from = {INHERIT_FROM}
/** /**
* Moves a template set and its subtemplates to the database * Moves a template set and its subtemplates to the database
* *
* @visibility public * @access public
* @param string $mode The component to move - only template is supported * @param string $mode The component to move - only template is supported
* @param int $id The template id * @param int $id The template id
*/ */
@ -3547,7 +3547,7 @@ inherit_from = {INHERIT_FROM}
/** /**
* Moves a template set to the database * Moves a template set to the database
* *
* @visibility private * @access private
* @param string $mode The component to move - only template is supported * @param string $mode The component to move - only template is supported
* @param int $id The template id * @param int $id The template id
* @param string $path TThe path to the template files * @param string $path TThe path to the template files
@ -3569,7 +3569,7 @@ inherit_from = {INHERIT_FROM}
/** /**
* Moves a template set and its subtemplates to the filesystem * Moves a template set and its subtemplates to the filesystem
* *
* @visibility public * @access public
* @param string $mode The component to move - only template is supported * @param string $mode The component to move - only template is supported
* @param int $id The template id * @param int $id The template id
*/ */
@ -3619,7 +3619,7 @@ inherit_from = {INHERIT_FROM}
/** /**
* Moves a template set to the filesystem * Moves a template set to the filesystem
* *
* @visibility private * @access private
* @param string $mode The component to move - only template is supported * @param string $mode The component to move - only template is supported
* @param int $id The template id * @param int $id The template id
* @param string $path The path to the template * @param string $path The path to the template

4
phpBB/includes/db/db_tools.php
View file

@ -593,7 +593,7 @@ class phpbb_db_tools
/** /**
* Private method for performing sql statements (either execute them or return them) * Private method for performing sql statements (either execute them or return them)
* @private * @access private
*/ */
function _sql_run_sql($statements) function _sql_run_sql($statements)
{ {
@ -624,7 +624,7 @@ class phpbb_db_tools
/** /**
* Function to prepare some column information for better usage * Function to prepare some column information for better usage
* @private * @access private
*/ */
function sql_prepare_column_data($table_name, $column_name, $column_data) function sql_prepare_column_data($table_name, $column_name, $column_data)
{ {

3
phpBB/includes/functions_upload.php
View file

@ -263,7 +263,8 @@ class filespec
* *
* @param string $destination_path Destination path, for example $config['avatar_path'] * @param string $destination_path Destination path, for example $config['avatar_path']
* @param bool $overwrite If set to true, an already existing file will be overwritten * @param bool $overwrite If set to true, an already existing file will be overwritten
* @param string $chmod Permission mask for chmodding the file after a successful move. The mode entered here reflects the mode of {@inline phpbb_chmod()} * @param string $chmod Permission mask for chmodding the file after a successful move. The mode entered here reflects the mode defined by {@link phpbb_chmod()}
*
* @access public * @access public
*/ */
function move_file($destination, $overwrite = false, $skip_image_check = false, $chmod = false) function move_file($destination, $overwrite = false, $skip_image_check = false, $chmod = false)

4
phpBB/includes/functions_user.php
View file

@ -147,7 +147,7 @@ function user_update_name($old_name, $new_name)
* *
* @param mixed $user_row An array containing the following keys (and the appropriate values): username, group_id (the group to place the user in), user_email and the user_type(usually 0). Additional entries not overridden by defaults will be forwarded. * @param mixed $user_row An array containing the following keys (and the appropriate values): username, group_id (the group to place the user in), user_email and the user_type(usually 0). Additional entries not overridden by defaults will be forwarded.
* @param string $cp_data custom profile fields, see custom_profile::build_insert_sql_array * @param string $cp_data custom profile fields, see custom_profile::build_insert_sql_array
* @return: the new user's ID. * @return the new user's ID.
*/ */
function user_add($user_row, $cp_data = false) function user_add($user_row, $cp_data = false)
{ {
@ -3087,7 +3087,7 @@ function group_validate_groupname($group_id, $group_name)
/** /**
* Set users default group * Set users default group
* *
* @private * @access private
*/ */
function group_set_user_default($group_id, $user_id_ary, $group_attributes = false, $update_listing = false) function group_set_user_default($group_id, $user_id_ary, $group_attributes = false, $update_listing = false)
{ {

2
phpBB/includes/message_parser.php
View file

@ -391,7 +391,7 @@ class bbcode_firstpass extends bbcode
/** /**
* Parse code text from code tag * Parse code text from code tag
* @private * @access private
*/ */
function bbcode_parse_code($stx, &$code) function bbcode_parse_code($stx, &$code)
{ {