From b2726296b6cad067fd0b134fc1e42987d4ec7b31 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Tue, 3 Aug 2010 01:49:23 +0000
Subject: - Patch #872068 by ksenzee: field.crud.inc has documentation TODOs.

---
 modules/field/field.crud.inc | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

(limited to 'modules')

diff --git a/modules/field/field.crud.inc b/modules/field/field.crud.inc
index dd46d4d43..aa1ee2f34 100644
--- a/modules/field/field.crud.inc
+++ b/modules/field/field.crud.inc
@@ -40,7 +40,7 @@
  * - field_name (string)
  *     The name of the field. Each field name is unique within Field API.
  *     When a field is attached to an entity, the field's data is stored
- *     in $entity->$field_name.
+ *     in $entity->$field_name. Maximum length is 32 characters.
  * - type (string)
  *     The type of the field, such as 'text' or 'image'. Field types
  *     are defined by modules that implement hook_field_info().
@@ -53,7 +53,9 @@
  * - translatable (integer)
  *     Whether the field is translatable.
  * - locked (integer)
- *     TODO: undefined.
+ *     Whether or not the field is available for editing. If TRUE, users can't
+ *     change field settings or create new instances of the field in the UI.
+ *     Defaults to FALSE.
  * - module (string, read-only)
  *     The name of the module that implements the field type.
  * - active (integer, read-only)
@@ -189,9 +191,6 @@
  *        - ...
  *
  * Bundles are represented by two strings, an entity type and a bundle name.
- *
- * TODO D7 : document max length for field types, widget types,
- * formatter names...
  */
 /**
  * @} End of "defgroup field_structs".
-- 
cgit v1.2.3