Browse files

phpdoc changes

  • Loading branch information...
1 parent 159be15 commit 83168de977f2dc8232d60759d5adae94b98c5882 @grangeway grangeway committed Nov 11, 2012
View
13 admin/check/check_api.php
@@ -121,7 +121,7 @@ function check_print_error_rows() {
/**
* Print section header
*
- * @param string heading
+ * @param string $p_heading heading
*/
function check_print_section_header_row( $p_heading ) {
?>
@@ -134,8 +134,8 @@ function check_print_section_header_row( $p_heading ) {
/**
* Print Check result - information only
*
- * @param string description
- * @param string information
+ * @param string $p_description description
+ * @param string $p_info information
*/
function check_print_info_row( $p_description, $p_info = null ) {
global $g_alternate_row, $g_show_all;
@@ -204,9 +204,10 @@ function check_print_test_row( $p_description, $p_pass, $p_info = null ) {
/**
* Print Check Test Warning Row
- * @param string description
- * @param bool pass
- * @param string information
+ * @param string $p_description description
+ * @param bool $p_pass pass
+ * @param string $p_info information
+ * @return bool
*/
function check_print_test_warn_row( $p_description, $p_pass, $p_info = null ) {
global $g_alternate_row, $g_show_all;
View
4 admin/check/check_integrity_inc.php
@@ -81,8 +81,8 @@ function get_release_containing_object_hash( $p_filename, $p_object_hash ) {
/**
* Get commit of object hash for given file
- * @param string filename of file contained in git repository
- * @param string object hash
+ * @param string $p_filename filename of file contained in git repository
+ * @param string $p_object_hash object hash
* @return string
*/
function get_commit_containing_object_hash( $p_filename, $p_object_hash ) {
View
12 admin/install.php
@@ -40,8 +40,8 @@
/**
* Print Check result - information only
*
- * @param string description
- * @param string information
+ * @param string $p_description description
+ * @param string $p_info information
*/
function print_info_row( $p_description, $p_info = null ) {
echo "\t<tr>\n\t\t<td bgcolor=\"#ffffff\">$p_description</td>\n";
@@ -79,10 +79,10 @@ function print_test_result( $p_result, $p_hard_fail = true, $p_message = '' ) {
/**
* Print Test result
*
- * @param string Test Description
- * @param int Result - BAD|GOOD
- * @param bool Fail installation or soft warning
- * @param string Message to display to user
+ * @param string $p_test_description Test Description
+ * @param int $p_result Result - BAD|GOOD
+ * @param bool $p_hard_fail Fail installation or soft warning
+ * @param string $p_message Message to display to user
*/
function print_test( $p_test_description, $p_result, $p_hard_fail = true, $p_message = '' ) {
View
8 admin/test_langs.php
@@ -100,8 +100,8 @@
/**
* Check directory of language files
*
- * @param string path
- * @param string sub path
+ * @param string $p_path path
+ * @param string $p_subpath sub path
*/
function checklangdir( $p_path, $p_subpath = '' ) {
$p_path = $p_path . DIRECTORY_SEPARATOR . $p_subpath . DIRECTORY_SEPARATOR;
@@ -192,8 +192,8 @@ function checkfile( $p_path, $p_file, $p_quiet = false ) {
/**
* Check Language File Tokens
*
- * @param string file
- * @param bool
+ * @param string $file file
+ * @param bool $base
* @return bool
*/
function checktoken( $file, $base = false ) {
View
8 config_defaults_inc.php
@@ -2357,13 +2357,9 @@
/**
* The regular expression to use when validating new user login names
- * The default regular expression allows a-z, A-Z, 0-9, +, -, dot, space and
- * underscore. If you change this, you may want to update the
- * ERROR_USER_NAME_INVALID string in the language files to explain
- * the rules you are using on your site
+ * The default regular expression allows a-z, A-Z, 0-9, +, -, dot, space and underscore.
* See http://en.wikipedia.org/wiki/Regular_Expression for more details about
- * regular expressions. For testing regular expressions, use
- * http://rubular.com/.
+ * regular expressions. For testing regular expressions, use http://rubular.com/.
* @global string $g_user_login_valid_regex
*/
$MantisConfig->user_login_valid_regex = '/^([a-z\d\-.+_ ]+(@[a-z\d\-.]+\.[a-z]{2,4})?)$/i';
View
2 core/current_user_api.php
@@ -203,7 +203,7 @@ function current_user_ensure_unprotected() {
* Returns the issue filter parameters for the current user
*
* @param int $p_project_id project id
- * @return Active issue filter for current user or false if no filter is currently defined.
+ * @return mixed Active issue filter for current user or false if no filter is currently defined.
* @access public
*/
function current_user_get_bug_filter( $p_project_id = null ) {
View
6 core/database_api.php
@@ -121,7 +121,7 @@ function db_is_mssql() {
* @param array $p_params Array of parameters matching $p_query
* @param int $p_limit Number of results to return
* @param int $p_offset offset query results for paging
- * @return ADORecordSet|bool Result set or false if the query failed.
+ * @return object|bool Result set or false if the query failed.
* @throws MantisBT\Exception\Database\QueryFailed
*/
function db_query( $p_query, $p_params = null, $p_limit = -1, $p_offset = -1 ) {
@@ -142,7 +142,7 @@ function db_query( $p_query, $p_params = null, $p_limit = -1, $p_offset = -1 ) {
/**
* Retrieve the next row returned from a specific database query
- * @param bool|ADORecordSet $p_result Database Query Record Set to retrieve next result for.
+ * @param bool|object $p_result Database Query Record Set to retrieve next result for.
* @return array Database result
*/
function db_fetch_array( &$p_result ) {
@@ -151,7 +151,7 @@ function db_fetch_array( &$p_result ) {
/**
* Retrieve a result returned from a specific database query
- * @param bool|ADORecordSet $p_result Database Query Record Set to retrieve next result for.
+ * @param bool|object $p_result Database Query Record Set to retrieve next result for.
* @param int $p_index1 Column to retrieve (optional)
* @return mixed Database result
*/
View
4 core/plugin_api.php
@@ -158,8 +158,8 @@ function plugin_file_include( $p_filename, $p_basename = null ) {
/**
* Given a base table name for a plugin, add appropriate prefix and suffix.
* Convenience for plugin schema definitions.
- * @param string Table name
- * @param string Plugin basename (defaults to current plugin)
+ * @param string $p_name Table name
+ * @param string $p_basename Plugin basename (defaults to current plugin)
* @return string Full table name
*/
function plugin_table( $p_name, $p_basename = null ) {
View
2 core/tag_api.php
@@ -152,7 +152,7 @@ function tag_cmp_name( $p_tag1, $p_tag2 ) {
* row of information returned. If the tag does not exist, a row is returned with
* id = -1 and the tag name, and if the name is invalid, a row is returned with
* id = -2 and the tag name. The resulting array is then sorted by tag name.
- * @param string Input string to parse
+ * @param string $p_string Input string to parse
* @return array Rows of tags parsed from input string
*/
function tag_parse_string( $p_string ) {
View
4 docbook/Admin_Guide/en-US/Configuration.xml
@@ -2125,9 +2125,7 @@
<para>
The regular expression to use when validating new user login names.
The default regular expression allows a-z, A-Z, 0-9, +, -, dot, space and
- underscore. If you change this, you may want to update the
- ERROR_USER_NAME_INVALID string in the language files to explain
- the rules you are using on your site.
+ underscore.
</para>
<para>
See <ulink url="http://en.wikipedia.org/wiki/Regular_Expression">Wikipedia</ulink> for more

0 comments on commit 83168de

Please sign in to comment.