diff -u b/fivestar.api.php b/fivestar.api.php --- b/fivestar.api.php +++ b/fivestar.api.php @@ -102,13 +102,13 @@ * * Invoked from fivestar_get_targets(). * - * @param $entity + * @param string $entity * The entity for the operation. - * @param $field + * @param string $field * The field structure for the operation. - * @param $instance + * @param string $instance * The instance structure for $field on $entity's bundle. - * @param $langcode + * @param string $langcode * The language associated with $items. * * @return array diff -u b/fivestar.module b/fivestar.module --- b/fivestar.module +++ b/fivestar.module @@ -258,13 +258,13 @@ * VotingAPI function votingapi_select_results() should be used, which is more * efficient when retrieving multiple votes. * - * @param $entity_type + * @param string $entity_type * The Entity type for which to retrieve votes. - * @param $id + * @param int $id * The ID for which to retrieve votes. - * @param $tag + * @param string $tag * The VotingAPI tag for which to retrieve votes. - * @param $uid + * @param int $uid * Optional. A user ID for which to retrieve votes. * * @return @@ -341,13 +341,13 @@ /** * Check that an item being voted upon is a valid vote. * - * @param $entity_type + * @param string $entity_type * Type of target. - * @param $id + * @param int $id * Identifier within the type. - * @param $tag + * @param string $tag * The VotingAPI tag string. - * @param $uid + * @param int $uid * The user trying to cast the vote. * * @return bool @@ -375,13 +375,13 @@ * modules to allow voting on any type of entity, such as nodes, users, or * comments. * - * @param $entity_type + * @param string $entity_type * Type entity. - * @param $id + * @param int $id * Identifier within the type. - * @param $tag + * @param string $tag * The VotingAPI tag string. - * @param $uid + * @param int $uid * The user ID trying to cast the vote. * * @return bool|null @@ -473,15 +473,15 @@ * drupal_get_form('fivestar_custom_widget', $values, $settings) when wanting * to display a widget. * - * @param $form_state + * @param array $form_state * The form state provided by Form API. - * @param $values + * @param array $values * An array of current vote values from 0 to 100, with the following array * keys: * - user: The user's current vote. * - average: The average vote value. * - count: The total number of votes so far on this content. - * @param $settings + * @param array $settings * An array of settings that configure the properties of the rating widget. * Available keys for the settings include: * - content_type: The type of content which will be voted upon. @@ -827,8 +827,8 @@ /** * Helper function to get the correct default value for a fivestar element. * - * @param $element - * The fivestar element + * @param array $element + * The fivestar element. * * @return * The default value for the element. diff -u b/includes/fivestar.field.inc b/includes/fivestar.field.inc --- b/includes/fivestar.field.inc +++ b/includes/fivestar.field.inc @@ -688,16 +688,16 @@ } /** - * @param $widgets + * @param array $widgets * Array, $widgets = module_invoke_all('fivestar_widgets'); * $widgets = array('path/to/css' => 'Widget Name', - * 'path/to/more/css' => 'Widget 2'); + * 'path/to/more/css' => 'Widget 2');. * - * @param $display + * @param array $display * Array. * This is the $display parameter passed to fivestar_field_formatter_view(). * - * @param $instance + * @param array $instance * Array. * This is the $instance parameter passed to fivestar_field_formatter_view(). * diff -u b/includes/fivestar.theme.inc b/includes/fivestar.theme.inc --- b/includes/fivestar.theme.inc +++ b/includes/fivestar.theme.inc @@ -185,11 +185,11 @@ /** * Display a plain HTML view-only version of the widget with a specified rating. * - * @param $rating + * @param int $rating * The desired rating to display out of 100 (i.e. 80 is 4 out of 5 stars). - * @param $stars + * @param int $stars * The total number of stars this rating is out of. - * @param $tag + * @param string $tag * Allows multiple ratings per node. * * @return @@ -248,13 +248,13 @@ * * All ratings are from 0 to 100. * - * @param $user_rating + * @param int $user_rating * The current user's rating. - * @param $average + * @param int $average * The average rating. - * @param $votes + * @param int $votes * The total number of votes. - * @param $stars + * @param int $stars * The number of stars being displayed. * * @return diff -u b/test/fivestar.base.test b/test/fivestar.base.test --- b/test/fivestar.base.test +++ b/test/fivestar.base.test @@ -13,17 +13,23 @@ /** * Use testing profile. * + * @var string + * * @see http://groups.drupal.org/node/217189 */ protected $profile = 'testing'; /** * A user with permission to administer Fivestar. + * + * @var user */ protected $adminUser; /** * A user with permission to vote. + * + * @var user */ protected $voterUser;