summaryrefslogtreecommitdiff
path: root/modules/field
diff options
context:
space:
mode:
authorwebchick <webchick@24967.no-reply.drupal.org>2012-02-14 13:58:09 -0500
committerwebchick <webchick@24967.no-reply.drupal.org>2012-02-14 13:58:09 -0500
commitd892dc24e88b6b6f18a2ffe144ea2efdc52f5691 (patch)
tree3968debd9e76bdf7ed53e4cc3faa12000a3a44d9 /modules/field
parent52b6df5b729dd53668de21776f879cc6d4ee22d3 (diff)
downloadbrdo-d892dc24e88b6b6f18a2ffe144ea2efdc52f5691.tar.gz
brdo-d892dc24e88b6b6f18a2ffe144ea2efdc52f5691.tar.bz2
Issue #1393234 by dww, Niklas Fiekas: Fixed API docs for field_access() are confusing.
Diffstat (limited to 'modules/field')
-rw-r--r--modules/field/field.module8
1 files changed, 5 insertions, 3 deletions
diff --git a/modules/field/field.module b/modules/field/field.module
index d110c4878..c2e5165e3 100644
--- 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.