Commit cda3f7f8 authored by Dries's avatar Dries
Browse files

- Patch #392686 by yched: more documentation clean-ups.

parent c59e50aa
...@@ -39,7 +39,8 @@ class FieldException extends Exception {} ...@@ -39,7 +39,8 @@ class FieldException extends Exception {}
* *
* @param array $field: * @param array $field:
* - id (integer, read-only) * - 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) * - field_name (string)
* The name of the field. Each field name is unique within Field API. * 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 * When a field is attached to an object, the field's data is stored
...@@ -78,9 +79,11 @@ class FieldException extends Exception {} ...@@ -78,9 +79,11 @@ class FieldException extends Exception {}
* *
* @param array $instance: * @param array $instance:
* - id (integer, read-only) * - 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) * - field_id (integer, read-only)
* The foreign key of the field attached to the bundle by this instance. * The foreign key of the field attached to the bundle by this instance.
* It is populated automatically by field_create_instance().
* - field_name (string) * - field_name (string)
* The name of the field attached to the bundle by this instance. * The name of the field attached to the bundle by this instance.
* - bundle (string) * - bundle (string)
...@@ -171,7 +174,7 @@ class FieldException extends Exception {} ...@@ -171,7 +174,7 @@ class FieldException extends Exception {}
* *
* @param $field * @param $field
* A field structure. The field_name and type properties are * A field structure. The field_name and type properties are
* required. Read-only properties are assigned automatically. * required.
* @throw * @throw
* FieldException * FieldException
*/ */
...@@ -317,7 +320,7 @@ function field_delete_field($field_name) { ...@@ -317,7 +320,7 @@ function field_delete_field($field_name) {
* *
* @param $instance * @param $instance
* A field instance structure. The field_name and bundle properties * A field instance structure. The field_name and bundle properties
* are required. Read-only properties are assigned automatically. * are required.
* @throw * @throw
* FieldException * FieldException
*/ */
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment