diff options
| author | Dries Buytaert <dries@buytaert.net> | 2009-03-13 14:34:58 +0000 |
|---|---|---|
| committer | Dries Buytaert <dries@buytaert.net> | 2009-03-13 14:34:58 +0000 |
| commit | cda3f7f8303508d5c0371aa14de80fefb903aaf3 (patch) | |
| tree | 6a3432be93b89ac255a9c7e787620c738820fdc1 | |
| parent | c59e50aa6dc5fcbdcb0d7e50f2a7c53c2f39c852 (diff) | |
| download | brdo-cda3f7f8303508d5c0371aa14de80fefb903aaf3.tar.gz brdo-cda3f7f8303508d5c0371aa14de80fefb903aaf3.tar.bz2 | |
- Patch #392686 by yched: more documentation clean-ups.
| -rw-r--r-- | modules/field/field.crud.inc | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/modules/field/field.crud.inc b/modules/field/field.crud.inc index 3c11abfd4..c0ef6d6cd 100644 --- a/modules/field/field.crud.inc +++ b/modules/field/field.crud.inc @@ -39,7 +39,8 @@ class FieldException extends Exception {} * * @param array $field: * - id (integer, read-only) - * The primary identifier of the field. + * The primary identifier of the field. It is assigned automatically + * by field_create_field(). * - field_name (string) * The name of the field. Each field name is unique within Field API. * When a field is attached to an object, the field's data is stored @@ -78,9 +79,11 @@ class FieldException extends Exception {} * * @param array $instance: * - id (integer, read-only) - * The primary identifier of this field instance. + * The primary identifier of this field instance. It is assigned + * automatically by field_create_instance(). * - field_id (integer, read-only) * The foreign key of the field attached to the bundle by this instance. + * It is populated automatically by field_create_instance(). * - field_name (string) * The name of the field attached to the bundle by this instance. * - bundle (string) @@ -171,7 +174,7 @@ class FieldException extends Exception {} * * @param $field * A field structure. The field_name and type properties are - * required. Read-only properties are assigned automatically. + * required. * @throw * FieldException */ @@ -317,7 +320,7 @@ function field_delete_field($field_name) { * * @param $instance * A field instance structure. The field_name and bundle properties - * are required. Read-only properties are assigned automatically. + * are required. * @throw * FieldException */ |