diff --git a/fivestar.migrate.inc b/fivestar.migrate.inc index 77a6d90..9e2af91 100644 --- a/fivestar.migrate.inc +++ b/fivestar.migrate.inc @@ -29,7 +29,7 @@ class MigrateFivestarFieldHandler extends MigrateFieldHandler { } /** - * Function fields() implementation. + * {@inheritdoc} */ public function fields($type, $parent_field, $migration = NULL) { $fields = array( diff --git a/fivestar.module b/fivestar.module index 83a9316..c50157e 100644 --- a/fivestar.module +++ b/fivestar.module @@ -331,7 +331,21 @@ function fivestar_get_votes_multiple($entity_type, $ids, $tag = 'vote', $uid = N } /** - * Implementing function fivestar_get_votes(). + * Function to get array of multiple votes. + * + * @param string $entity_type + * The Entity type for which to retrieve votes. + * @param int $id + * The ID for which to retrieve votes. + * @param string $tag + * The VotingAPI tag for which to retrieve votes. + * @param int $uid + * Optional. A user ID for which to retrieve votes. + * + * @return array + * An array of the following keys: + * - entity_type: An array of VotingAPI results, including the entity_type. + * - id: An array of VotingAPI results, including the id. */ function fivestar_get_votes($entity_type, $id, $tag = 'vote', $uid = NULL) { $multiple = fivestar_get_votes_multiple($entity_type, array($id), $tag, $uid); @@ -1128,7 +1142,7 @@ function _fivestar_allow_vote($element) { } /** - * Implements hook_ctools_content_subtype_alter() + * Implements hook_ctools_content_subtype_alter(). */ function fivestar_ctools_content_subtype_alter(&$subtype, &$plugin) { if ($plugin['name'] == 'entity_field' && isset($subtype['subtype_id'])) { diff --git a/includes/fivestar.field.inc b/includes/fivestar.field.inc index 0407aab..424294a 100644 --- a/includes/fivestar.field.inc +++ b/includes/fivestar.field.inc @@ -28,9 +28,11 @@ function fivestar_field_info() { ); } -/** - * Implementing function fivestar_form_field_ui_field_edit_form_alter(). - */ + /** + * Implements hook_form_FORM_ID_alter(). + * + * Setting values if field type is of fivestar. + */ function fivestar_form_field_ui_field_edit_form_alter(&$form, $form_state) { $field = $form['#field']; $instance = $form['#instance']; diff --git a/test/fivestar.base.test b/test/fivestar.base.test index 8031331..5c10d74 100644 --- a/test/fivestar.base.test +++ b/test/fivestar.base.test @@ -21,15 +21,11 @@ class FivestarBaseTestCase extends AJAXTestCase { /** * A user with permission to administer Fivestar. - * - * @var user */ protected $adminUser; /** * A user with permission to vote. - * - * @var user */ protected $voterUser;