PHPDoc and code style fixes

mantisbt · Jun 16, 2016 · c76a7d9 · c76a7d9
1 parent 04e83a8
commit c76a7d9
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git a/core/classes/ConfigParser.class.php b/core/classes/ConfigParser.class.php
@@ -58,7 +58,7 @@ public function __construct( $p_code ) {
 	 * Parse the code for a variable assignment.
 	 * Handles scalar types, and various array types (simple, associative,
 	 * multi-dimentional)
-	 * @param bool $p_extra_tokens Define how extra tokens should be handled
+	 * @param integer $p_extra_tokens Define how extra tokens should be handled
 	 *                             - EXTRA_TOKENS_IGNORE silently ignore any
 	 *                               extra code given after the first token
 	 *                             - EXTRA_TOKENS_ERROR (default) throws an

diff --git a/core/classes/TimelineEvent.class.php b/core/classes/TimelineEvent.class.php
@@ -72,7 +72,7 @@ public function format_timestamp( $p_timestamp ) {
 	 * @param string $p_action_icon Icon name for Font Awesome
 	 * @return string
 	 */
-	public function html_start( $p_action_icon = 'fa-check') {
+	public function html_start( $p_action_icon = 'fa-check' ) {
 		$t_avatar = Avatar::get( $this->user_id, 40 );
 		$t_html = '<div class="profile-activity clearfix">';
 

diff --git a/core/print_api.php b/core/print_api.php
@@ -1353,6 +1353,7 @@ function print_view_bug_sort_link( $p_string, $p_sort_field, $p_sort, $p_dir, $p
  * @param integer $p_hide_inactive Whether to hide inactive users.
  * @param integer $p_filter        The filter to use.
  * @param integer $p_show_disabled Whether to show disabled users.
+ * @param string  $p_class         The CSS class of the link.
  * @return void
  */
 function print_manage_user_sort_link( $p_page, $p_string, $p_field, $p_dir, $p_sort_by, $p_hide_inactive = 0, $p_filter = ALL, $p_show_disabled = 0, $p_class = '' ) {
@@ -1412,6 +1413,7 @@ function print_manage_project_sort_link( $p_page, $p_string, $p_field, $p_dir, $
  * @param array  $p_args_to_post   Associative array of arguments to be posted, with
  *                                 arg name => value, defaults to null (no args).
  * @param mixed  $p_security_token Optional; null (default), OFF or security token string.
+ * @param string $p_class          The CSS class of the button.
  * @see form_security_token()
  * @return void
  */

diff --git a/core/timeline_api.php b/core/timeline_api.php
@@ -104,15 +104,14 @@ function timeline_events( $p_start_time, $p_end_time, $p_max_events ) {
 /**
  * Print for display an array of events
  * @param array $p_events   Array of events to display
+ * @return void
  */
 function timeline_print_events( array $p_events ) {
 	if( empty( $p_events ) ) {
 		echo '<h6 class="padding-4">' . lang_get( 'timeline_no_activity' ) . '</h6>';
-		return 0;
-	}
-
-	foreach( $p_events as $t_event ) {
-		echo $t_event->html();
+	} else {
+		foreach( $p_events as $t_event ) {
+			echo $t_event->html();
+		}
 	}
 }
-