Issue #1393234 by dww, Niklas Fiekas: Fixed API docs for field_access() are confusing.

2012-02-14 13:58:09 -05:00 · 2012-02-14 13:58:09 -05:00 · d892dc24e8
parent 52b6df5b72
commit d892dc24e8
1 changed files with 5 additions and 3 deletions
--- a/modules/field/field.module
+++ b/modules/field/field.module
@ -994,16 +994,18 @@ function field_has_data($field) {
 *
 * @param $op
 *   The operation to be performed. Possible values:
- *   - "edit"
- *   - "view"
+ *   - 'edit'
+ *   - 'view'
 * @param $field
- *   The field on which the operation is to be performed.
+ *   The full field structure array for the field on which the operation is to
+ *   be performed. See field_info_field().
 * @param $entity_type
 *   The type of $entity; e.g., 'node' or 'user'.
 * @param $entity
 *   (optional) The entity for the operation.
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
+ *
 * @return
 *   TRUE if the operation is allowed;
 *   FALSE if the operation is denied.