summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorAngie Byron <webchick@24967.no-reply.drupal.org>2011-01-02 17:26:40 +0000
committerAngie Byron <webchick@24967.no-reply.drupal.org>2011-01-02 17:26:40 +0000
commit7264290ea8117a9b65d181e55b7d36658c04ecbb (patch)
tree73d4eb4f745ae45421d8072ce4def9a50155061a /modules
parentd30dd0617ef725ec8744b4cf56c7e159f10039b6 (diff)
downloadbrdo-7264290ea8117a9b65d181e55b7d36658c04ecbb.tar.gz
brdo-7264290ea8117a9b65d181e55b7d36658c04ecbb.tar.bz2
#987384 by h_peter, jhodgdon: Fixed Topics/groups in D7 need cleanup
Diffstat (limited to 'modules')
-rw-r--r--modules/block/block.install5
-rw-r--r--modules/comment/comment.install5
-rw-r--r--modules/contact/contact.install5
-rw-r--r--modules/dblog/dblog.install5
-rw-r--r--modules/field/field.crud.inc201
-rw-r--r--modules/field/field.install4
-rw-r--r--modules/field/field.module186
-rw-r--r--modules/field/modules/field_sql_storage/field_sql_storage.install4
-rw-r--r--modules/filter/filter.install5
-rw-r--r--modules/locale/locale.admin.inc81
-rw-r--r--modules/locale/locale.install4
-rw-r--r--modules/node/node.install5
-rw-r--r--modules/node/node.module1
-rw-r--r--modules/openid/openid.install5
-rw-r--r--modules/statistics/statistics.install5
-rw-r--r--modules/system/system.install3
-rw-r--r--modules/taxonomy/taxonomy.module3
-rw-r--r--modules/tracker/tracker.install5
-rw-r--r--modules/update/update.install5
-rw-r--r--modules/update/update.manager.inc16
-rw-r--r--modules/update/update.module1
-rw-r--r--modules/user/user.install5
22 files changed, 253 insertions, 306 deletions
diff --git a/modules/block/block.install b/modules/block/block.install
index 7567499f3..ef279d959 100644
--- a/modules/block/block.install
+++ b/modules/block/block.install
@@ -206,7 +206,7 @@ function block_update_dependencies() {
}
/**
- * @defgroup updates-6.x-to-7.x Block updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -462,6 +462,5 @@ function block_update_7007() {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/comment/comment.install b/modules/comment/comment.install
index 1ba3a5c6a..c22655f62 100644
--- a/modules/comment/comment.install
+++ b/modules/comment/comment.install
@@ -99,7 +99,7 @@ function comment_update_dependencies() {
}
/**
- * @defgroup updates-6.x-to-7.x Comment updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -338,8 +338,7 @@ function comment_update_7006(&$sandbox) {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
/**
diff --git a/modules/contact/contact.install b/modules/contact/contact.install
index 435156ded..3c4e934a7 100644
--- a/modules/contact/contact.install
+++ b/modules/contact/contact.install
@@ -90,7 +90,7 @@ function contact_uninstall() {
}
/**
- * @defgroup updates-6.x-to-7.x Contact updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -146,6 +146,5 @@ function contact_update_7003() {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/dblog/dblog.install b/modules/dblog/dblog.install
index 5fc425749..bb56903a9 100644
--- a/modules/dblog/dblog.install
+++ b/modules/dblog/dblog.install
@@ -93,7 +93,7 @@ function dblog_schema() {
}
/**
- * @defgroup updates-6.x-to-7.x database logging updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -132,6 +132,5 @@ function dblog_update_7001() {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/field/field.crud.inc b/modules/field/field.crud.inc
index 5ff274826..eda3218c5 100644
--- a/modules/field/field.crud.inc
+++ b/modules/field/field.crud.inc
@@ -7,201 +7,6 @@
*/
/**
- * @defgroup field_structs Field API data structures
- * @{
- * Represent Field API fields and instances.
- *
- * The Field API defines two primary data structures, Field and
- * Instance, and the concept of a Bundle. A Field defines a
- * particular type of data that can be attached to entities. A Field
- * Instance is a Field attached to a single Bundle. A Bundle is a set
- * of fields that are treated as a group by the Field Attach API and
- * is related to a single fieldable entity type.
- *
- * For example, suppose a site administrator wants Article nodes to
- * have a subtitle and photo. Using the Field API or Field UI module,
- * the administrator creates a field named 'subtitle' of type 'text'
- * and a field named 'photo' of type 'image'. The administrator
- * (again, via a UI) creates two Field Instances, one attaching the
- * field 'subtitle' to the 'node' bundle 'article' and one attaching
- * the field 'photo' to the 'node' bundle 'article'. When the node
- * system uses the Field Attach API to load all fields for an Article
- * node, it passes the node's entity type (which is 'node') and
- * content type (which is 'article') as the node's bundle.
- * field_attach_load() then loads the 'subtitle' and 'photo' fields
- * because they are both attached to the 'node' bundle 'article'.
- *
- * Field definitions are represented as an array of key/value pairs.
- *
- * @param array $field:
- * - id (integer, read-only)
- * 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 entity, the field's data is stored
- * 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().
- * - entity_types (array)
- * The array of entity types that can hold instances of this field. If
- * empty or not specified, the field can have instances in any entity type.
- * - cardinality (integer)
- * The number of values the field can hold. Legal values are any
- * positive integer or FIELD_CARDINALITY_UNLIMITED.
- * - translatable (integer)
- * Whether the field is translatable.
- * - locked (integer)
- * 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)
- * TRUE if the module that implements the field type is currently
- * enabled, FALSE otherwise.
- * - deleted (integer, read-only)
- * TRUE if this field has been deleted, FALSE otherwise. Deleted
- * fields are ignored by the Field Attach API. This property exists
- * because fields can be marked for deletion but only actually
- * destroyed by a separate garbage-collection process.
- * - columns (array, read-only).
- * An array of the Field API columns used to store each value of
- * this field. The column list may depend on field settings; it is
- * not constant per field type. Field API column specifications are
- * exactly like Schema API column specifications but, depending on
- * the field storage module in use, the name of the column may not
- * represent an actual column in an SQL database.
- * - indexes (array).
- * An array of indexes on data columns, using the same definition format
- * as Schema API index specifications. Only columns that appear in the
- * 'columns' setting are allowed. Note that field types can specify
- * default indexes, which can be modified or added to when
- * creating a field.
- * - foreign keys: (optional) An associative array of relations, using the same
- * structure as the 'foreign keys' definition of hook_schema(). Note, however,
- * that the field data is not necessarily stored in SQL. Also, the possible
- * usage is limited, as you cannot specify another field as related, only
- * existing SQL tables, such as filter formats.
- * - settings (array)
- * A sub-array of key/value pairs of field-type-specific settings. Each
- * field type module defines and documents its own field settings.
- * - storage (array)
- * A sub-array of key/value pairs identifying the storage backend to use for
- * the for the field.
- * - type (string)
- * The storage backend used by the field. Storage backends are defined
- * by modules that implement hook_field_storage_info().
- * - module (string, read-only)
- * The name of the module that implements the storage backend.
- * - active (integer, read-only)
- * TRUE if the module that implements the storage backend is currently
- * enabled, FALSE otherwise.
- * - settings (array)
- * A sub-array of key/value pairs of settings. Each storage backend
- * defines and documents its own settings.
- *
- * Field instance definitions are represented as an array of key/value pairs.
- *
- * @param array $instance:
- * - id (integer, read-only)
- * 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.
- * - entity_type (string)
- * The name of the entity type the instance is attached to.
- * - bundle (string)
- * The name of the bundle that the field is attached to.
- * - label (string)
- * A human-readable label for the field when used with this
- * bundle. For example, the label will be the title of Form API
- * elements for this instance.
- * - description (string)
- * A human-readable description for the field when used with this
- * bundle. For example, the description will be the help text of
- * Form API elements for this instance.
- * - required (integer)
- * TRUE if a value for this field is required when used with this
- * bundle, FALSE otherwise. Currently, required-ness is only enforced
- * during Form API operations, not by field_attach_load(),
- * field_attach_insert(), or field_attach_update().
- * - default_value_function (string)
- * The name of the function, if any, that will provide a default value.
- * - default_value (array)
- * If default_value_function is not set, then fixed values can be provided.
- * - deleted (integer, read-only)
- * TRUE if this instance has been deleted, FALSE otherwise.
- * Deleted instances are ignored by the Field Attach API.
- * This property exists because instances can be marked for deletion but
- * only actually destroyed by a separate garbage-collection process.
- * - settings (array)
- * A sub-array of key/value pairs of field-type-specific instance
- * settings. Each field type module defines and documents its own
- * instance settings.
- * - widget (array)
- * A sub-array of key/value pairs identifying the Form API input widget
- * for the field when used by this bundle.
- * - type (string)
- * The type of the widget, such as text_textfield. Widget types
- * are defined by modules that implement hook_field_widget_info().
- * - settings (array)
- * A sub-array of key/value pairs of widget-type-specific settings.
- * Each field widget type module defines and documents its own
- * widget settings.
- * - weight (float)
- * The weight of the widget relative to the other elements in entity
- * edit forms.
- * - module (string, read-only)
- * The name of the module that implements the widget type.
- * - display (array)
- * A sub-array of key/value pairs identifying the way field values should
- * be displayed in each of the entity type's view modes, plus the 'default'
- * mode. For each view mode, Field UI lets site administrators define
- * whether they want to use a dedicated set of display options or the
- * 'default' options to reduce the number of displays to maintain as they
- * add new fields. For nodes, on a fresh install, only the 'teaser' view
- * mode is configured to use custom display options, all other view modes
- * defined use the 'default' options by default. When programmatically
- * adding field instances on nodes, it is therefore recommended to at least
- * specify display options for 'default' and 'teaser'.
- * - default (array)
- * A sub-array of key/value pairs describing the display options to be
- * used when the field is being displayed in view modes that are not
- * configured to use dedicated display options.
- * - label (string)
- * Position of the label. 'inline', 'above' and 'hidden' are the
- * values recognized by the default 'field' theme implementation.
- * - type (string)
- * The type of the display formatter, or 'hidden' for no display.
- * - settings (array)
- * A sub-array of key/value pairs of display options specific to
- * the formatter.
- * - weight (float)
- * The weight of the field relative to the other entity components
- * displayed in this view mode.
- * - module (string, read-only)
- * The name of the module which implements the display formatter.
- * - some_mode
- * A sub-array of key/value pairs describing the display options to be
- * used when the field is being displayed in the 'some_mode' view mode.
- * Those options will only be actually applied at run time if the view
- * mode is not configured to use default settings for this bundle.
- * - ...
- * - other_mode
- * - ...
- *
- * Bundles are represented by two strings, an entity type and a bundle name.
- */
-/**
- * @} End of "defgroup field_structs".
- */
-
-/**
* @defgroup field_crud Field CRUD API
* @{
* Create, update, and delete Field API fields, bundles, and instances.
@@ -210,7 +15,7 @@
* data structures. UI modules will use it to create a user interface.
*
* The Field CRUD API uses
- * @link field_structs Field API data structures @endlink.
+ * @link field Field API data structures @endlink.
*/
/**
@@ -243,7 +48,7 @@
* @throw
* FieldException
*
- * See: @link field_structs Field API data structures @endlink.
+ * See: @link field Field API data structures @endlink.
*/
function field_create_field($field) {
// Field name is required.
@@ -642,7 +447,7 @@ function field_delete_field($field_name) {
* @throw
* FieldException
*
- * See: @link field_structs Field API data structures @endlink.
+ * See: @link field Field API data structures @endlink.
*/
function field_create_instance($instance) {
$field = field_read_field($instance['field_name']);
diff --git a/modules/field/field.install b/modules/field/field.install
index 2b6c0698f..02455c4e1 100644
--- a/modules/field/field.install
+++ b/modules/field/field.install
@@ -379,7 +379,7 @@ function _update_7000_field_create_instance($field, &$instance) {
}
/**
- * @defgroup field-updates-6.x-to-7.x Field updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -427,5 +427,5 @@ function field_update_7001() {
}
/**
- * @} End of "defgroup field-updates-6.x-to-7.x"
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/field/field.module b/modules/field/field.module
index e96bdb0ce..08ee9d594 100644
--- a/modules/field/field.module
+++ b/modules/field/field.module
@@ -38,7 +38,191 @@ require_once DRUPAL_ROOT . '/modules/field/field.form.inc';
* fields via a web browser as well as a wide and flexible variety of
* data type, form element, and display format capabilities.
*
- * - @link field_structs Data structures: Field, Instance, Bundle @endlink.
+ * The Field API defines two primary data structures, Field and
+ * Instance, and the concept of a Bundle. A Field defines a
+ * particular type of data that can be attached to entities. A Field
+ * Instance is a Field attached to a single Bundle. A Bundle is a set
+ * of fields that are treated as a group by the Field Attach API and
+ * is related to a single fieldable entity type.
+ *
+ * For example, suppose a site administrator wants Article nodes to
+ * have a subtitle and photo. Using the Field API or Field UI module,
+ * the administrator creates a field named 'subtitle' of type 'text'
+ * and a field named 'photo' of type 'image'. The administrator
+ * (again, via a UI) creates two Field Instances, one attaching the
+ * field 'subtitle' to the 'node' bundle 'article' and one attaching
+ * the field 'photo' to the 'node' bundle 'article'. When the node
+ * system uses the Field Attach API to load all fields for an Article
+ * node, it passes the node's entity type (which is 'node') and
+ * content type (which is 'article') as the node's bundle.
+ * field_attach_load() then loads the 'subtitle' and 'photo' fields
+ * because they are both attached to the 'node' bundle 'article'.
+ *
+ * Field definitions are represented as an array of key/value pairs.
+ *
+ * array $field:
+ * - id (integer, read-only)
+ * 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 entity, the field's data is stored
+ * 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().
+ * - entity_types (array)
+ * The array of entity types that can hold instances of this field. If
+ * empty or not specified, the field can have instances in any entity type.
+ * - cardinality (integer)
+ * The number of values the field can hold. Legal values are any
+ * positive integer or FIELD_CARDINALITY_UNLIMITED.
+ * - translatable (integer)
+ * Whether the field is translatable.
+ * - locked (integer)
+ * 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)
+ * TRUE if the module that implements the field type is currently
+ * enabled, FALSE otherwise.
+ * - deleted (integer, read-only)
+ * TRUE if this field has been deleted, FALSE otherwise. Deleted
+ * fields are ignored by the Field Attach API. This property exists
+ * because fields can be marked for deletion but only actually
+ * destroyed by a separate garbage-collection process.
+ * - columns (array, read-only).
+ * An array of the Field API columns used to store each value of
+ * this field. The column list may depend on field settings; it is
+ * not constant per field type. Field API column specifications are
+ * exactly like Schema API column specifications but, depending on
+ * the field storage module in use, the name of the column may not
+ * represent an actual column in an SQL database.
+ * - indexes (array).
+ * An array of indexes on data columns, using the same definition format
+ * as Schema API index specifications. Only columns that appear in the
+ * 'columns' setting are allowed. Note that field types can specify
+ * default indexes, which can be modified or added to when
+ * creating a field.
+ * - foreign keys: (optional) An associative array of relations, using the same
+ * structure as the 'foreign keys' definition of hook_schema(). Note, however,
+ * that the field data is not necessarily stored in SQL. Also, the possible
+ * usage is limited, as you cannot specify another field as related, only
+ * existing SQL tables, such as filter formats.
+ * - settings (array)
+ * A sub-array of key/value pairs of field-type-specific settings. Each
+ * field type module defines and documents its own field settings.
+ * - storage (array)
+ * A sub-array of key/value pairs identifying the storage backend to use for
+ * the for the field.
+ * - type (string)
+ * The storage backend used by the field. Storage backends are defined
+ * by modules that implement hook_field_storage_info().
+ * - module (string, read-only)
+ * The name of the module that implements the storage backend.
+ * - active (integer, read-only)
+ * TRUE if the module that implements the storage backend is currently
+ * enabled, FALSE otherwise.
+ * - settings (array)
+ * A sub-array of key/value pairs of settings. Each storage backend
+ * defines and documents its own settings.
+ *
+ * Field instance definitions are represented as an array of key/value pairs.
+ *
+ * array $instance:
+ * - id (integer, read-only)
+ * 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.
+ * - entity_type (string)
+ * The name of the entity type the instance is attached to.
+ * - bundle (string)
+ * The name of the bundle that the field is attached to.
+ * - label (string)
+ * A human-readable label for the field when used with this
+ * bundle. For example, the label will be the title of Form API
+ * elements for this instance.
+ * - description (string)
+ * A human-readable description for the field when used with this
+ * bundle. For example, the description will be the help text of
+ * Form API elements for this instance.
+ * - required (integer)
+ * TRUE if a value for this field is required when used with this
+ * bundle, FALSE otherwise. Currently, required-ness is only enforced
+ * during Form API operations, not by field_attach_load(),
+ * field_attach_insert(), or field_attach_update().
+ * - default_value_function (string)
+ * The name of the function, if any, that will provide a default value.
+ * - default_value (array)
+ * If default_value_function is not set, then fixed values can be provided.
+ * - deleted (integer, read-only)
+ * TRUE if this instance has been deleted, FALSE otherwise.
+ * Deleted instances are ignored by the Field Attach API.
+ * This property exists because instances can be marked for deletion but
+ * only actually destroyed by a separate garbage-collection process.
+ * - settings (array)
+ * A sub-array of key/value pairs of field-type-specific instance
+ * settings. Each field type module defines and documents its own
+ * instance settings.
+ * - widget (array)
+ * A sub-array of key/value pairs identifying the Form API input widget
+ * for the field when used by this bundle.
+ * - type (string)
+ * The type of the widget, such as text_textfield. Widget types
+ * are defined by modules that implement hook_field_widget_info().
+ * - settings (array)
+ * A sub-array of key/value pairs of widget-type-specific settings.
+ * Each field widget type module defines and documents its own
+ * widget settings.
+ * - weight (float)
+ * The weight of the widget relative to the other elements in entity
+ * edit forms.
+ * - module (string, read-only)
+ * The name of the module that implements the widget type.
+ * - display (array)
+ * A sub-array of key/value pairs identifying the way field values should
+ * be displayed in each of the entity type's view modes, plus the 'default'
+ * mode. For each view mode, Field UI lets site administrators define
+ * whether they want to use a dedicated set of display options or the
+ * 'default' options to reduce the number of displays to maintain as they
+ * add new fields. For nodes, on a fresh install, only the 'teaser' view
+ * mode is configured to use custom display options, all other view modes
+ * defined use the 'default' options by default. When programmatically
+ * adding field instances on nodes, it is therefore recommended to at least
+ * specify display options for 'default' and 'teaser'.
+ * - default (array)
+ * A sub-array of key/value pairs describing the display options to be
+ * used when the field is being displayed in view modes that are not
+ * configured to use dedicated display options.
+ * - label (string)
+ * Position of the label. 'inline', 'above' and 'hidden' are the
+ * values recognized by the default 'field' theme implementation.
+ * - type (string)
+ * The type of the display formatter, or 'hidden' for no display.
+ * - settings (array)
+ * A sub-array of key/value pairs of display options specific to
+ * the formatter.
+ * - weight (float)
+ * The weight of the field relative to the other entity components
+ * displayed in this view mode.
+ * - module (string, read-only)
+ * The name of the module which implements the display formatter.
+ * - some_mode
+ * A sub-array of key/value pairs describing the display options to be
+ * used when the field is being displayed in the 'some_mode' view mode.
+ * Those options will only be actually applied at run time if the view
+ * mode is not configured to use default settings for this bundle.
+ * - ...
+ * - other_mode
+ * - ...
+ *
+ * Bundles are represented by two strings, an entity type and a bundle name.
*
* - @link field_types Field Types API @endlink. Defines field types,
* widget types, and display formatters. Field modules use this API
diff --git a/modules/field/modules/field_sql_storage/field_sql_storage.install b/modules/field/modules/field_sql_storage/field_sql_storage.install
index 6bb53bf47..04d6859f7 100644
--- a/modules/field/modules/field_sql_storage/field_sql_storage.install
+++ b/modules/field/modules/field_sql_storage/field_sql_storage.install
@@ -83,7 +83,7 @@ function _update_7000_field_sql_storage_write($entity_type, $bundle, $entity_id,
}
/**
- * @defgroup field-sql-storage-updates-6.x-to-7.x Field SQL storage updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -212,5 +212,5 @@ function field_sql_storage_update_7002() {
}
/**
- * @} End of "defgroup field-updates-6.x-to-7.x"
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/filter/filter.install b/modules/filter/filter.install
index 2d9c6af64..ef9d71853 100644
--- a/modules/filter/filter.install
+++ b/modules/filter/filter.install
@@ -162,7 +162,7 @@ function filter_update_dependencies() {
return $dependencies;
}
/**
- * @defgroup updates-6.x-to-7.x Filter updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -490,6 +490,5 @@ function filter_update_7010() {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/locale/locale.admin.inc b/modules/locale/locale.admin.inc
index 9189c7149..118e9212c 100644
--- a/modules/locale/locale.admin.inc
+++ b/modules/locale/locale.admin.inc
@@ -7,8 +7,12 @@
*/
/**
- * @defgroup locale-language-overview Language overview functionality
+ * @defgroup locale-language-administration Language administration interface
* @{
+ * Administration interface for languages.
+ *
+ * These functions provide the user interface to show, add, edit and
+ * delete languages as well as providing options for language negotiation.
*/
/**
@@ -161,14 +165,6 @@ function locale_languages_overview_form_submit($form, &$form_state) {
$form_state['redirect'] = 'admin/config/regional/language';
return;
}
-/**
- * @} End of "locale-language-overview"
- */
-
-/**
- * @defgroup locale-language-add-edit Language addition and editing functionality
- * @{
- */
/**
* User interface for the language addition screen.
@@ -421,14 +417,6 @@ function locale_languages_edit_form_submit($form, &$form_state) {
$form_state['redirect'] = 'admin/config/regional/language';
return;
}
-/**
- * @} End of "locale-language-add-edit"
- */
-
-/**
- * @defgroup locale-language-delete Language deletion functionality
- * @{
- */
/**
* User interface for the language deletion confirmation screen.
@@ -492,14 +480,6 @@ function locale_languages_delete_form_submit($form, &$form_state) {
$form_state['redirect'] = 'admin/config/regional/language';
return;
}
-/**
- * @} End of "locale-language-add-edit"
- */
-
-/**
- * @defgroup locale-languages-negotiation Language negotiation options
- * @{
- */
/**
* Setting for language negotiation options
@@ -759,12 +739,16 @@ function locale_language_providers_session_form($form, &$form_state) {
}
/**
- * @} End of "locale-languages-negotiation"
+ * @} End of "locale-language-administration"
*/
/**
- * @defgroup locale-translate-overview Translation overview screen.
+ * @defgroup locale-translate-administration-screens Translation administration screens.
* @{
+ * Screens for translation administration.
+ *
+ * These functions provide various screens as administration interface
+ * to import, export and view translations.
*/
/**
@@ -803,14 +787,6 @@ function locale_translate_overview_screen() {
return theme('table', array('header' => $headers, 'rows' => $rows));
}
-/**
- * @} End of "locale-translate-overview"
- */
-
-/**
- * @defgroup locale-translate-seek Translation search screen.
- * @{
- */
/**
* String search screen.
@@ -948,15 +924,6 @@ function locale_translation_filter_form_submit($form, &$form_state) {
}
/**
- * @} End of "locale-translate-seek"
- */
-
-/**
- * @defgroup locale-translate-import Translation import screen.
- * @{
- */
-
-/**
* User interface for the translation import screen.
*/
function locale_translate_import_form($form) {
@@ -1045,14 +1012,6 @@ function locale_translate_import_form_submit($form, &$form_state) {
$form_state['redirect'] = 'admin/config/regional/translate';
return;
}
-/**
- * @} End of "locale-translate-import"
- */
-
-/**
- * @defgroup locale-translate-export Translation export screen.
- * @{
- */
/**
* User interface for the translation export screen.
@@ -1132,12 +1091,16 @@ function locale_translate_export_po_form_submit($form, &$form_state) {
_locale_export_po($language, _locale_export_po_generate($language, _locale_export_get_strings($language, $form_state['values']['group'])));
}
/**
- * @} End of "locale-translate-export"
+ * @} End of "locale-translate-administration-screens"
*/
/**
- * @defgroup locale-translate-edit Translation text editing
+ * @defgroup locale-translate-edit-delete Translation editing/deletion interface
* @{
+ * Edit and delete translation strings.
+ *
+ * These functions provide the user interface to edit and delete
+ * translation strings.
*/
/**
@@ -1272,14 +1235,6 @@ function locale_translate_edit_form_submit($form, &$form_state) {
$form_state['redirect'] = 'admin/config/regional/translate/translate';
return;
}
-/**
- * @} End of "locale-translate-edit"
- */
-
-/**
- * @defgroup locale-translate-delete Translation delete interface.
- * @{
- */
/**
* String deletion confirmation page.
@@ -1318,7 +1273,7 @@ function locale_translate_delete_form_submit($form, &$form_state) {
$form_state['redirect'] = 'admin/config/regional/translate/translate';
}
/**
- * @} End of "locale-translate-delete"
+ * @} End of "locale-translate-edit-delete"
*/
/**
diff --git a/modules/locale/locale.install b/modules/locale/locale.install
index 0c95d001d..2594667d0 100644
--- a/modules/locale/locale.install
+++ b/modules/locale/locale.install
@@ -28,7 +28,7 @@ function locale_install() {
}
/**
- * @defgroup updates-6.x-to-7.x Locale updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -127,7 +127,7 @@ function locale_update_7002() {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
/**
diff --git a/modules/node/node.install b/modules/node/node.install
index 4cf1d04b0..4be27cbe8 100644
--- a/modules/node/node.install
+++ b/modules/node/node.install
@@ -446,7 +446,7 @@ function _update_7000_node_get_types() {
}
/**
- * @defgroup updates-6.x-to-7.x System updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -804,6 +804,5 @@ function node_update_7010() {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/node/node.module b/modules/node/node.module
index b238c9e85..9ca4f470b 100644
--- a/modules/node/node.module
+++ b/modules/node/node.module
@@ -3493,6 +3493,7 @@ function _node_access_rebuild_batch_finished($success, $results, $operations) {
/**
* @defgroup node_content Hook implementations for user-created content types.
* @{
+ * Functions that implement hooks for user-created content types.
*/
/**
diff --git a/modules/openid/openid.install b/modules/openid/openid.install
index 404cb2fdd..5a90568de 100644
--- a/modules/openid/openid.install
+++ b/modules/openid/openid.install
@@ -112,7 +112,7 @@ function openid_requirements($phase) {
}
/**
- * @defgroup updates-6.x-extra Extra openid updates for 6.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -150,6 +150,5 @@ function openid_update_6000() {
}
/**
- * @} End of "defgroup updates-6.x-extra"
- * The next series of updates should start at 7000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/statistics/statistics.install b/modules/statistics/statistics.install
index aa9b70ee9..b0b016b37 100644
--- a/modules/statistics/statistics.install
+++ b/modules/statistics/statistics.install
@@ -137,7 +137,7 @@ function statistics_schema() {
}
/**
- * @defgroup updates-6.x-to-7.x statistics updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -155,6 +155,5 @@ function statistics_update_7000() {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/system/system.install b/modules/system/system.install
index c0796027b..eb6d01736 100644
--- a/modules/system/system.install
+++ b/modules/system/system.install
@@ -1718,8 +1718,9 @@ function system_update_dependencies() {
}
/**
- * @defgroup updates-6.x-to-7.x System updates from 6.x to 7.x
+ * @defgroup updates-6.x-to-7.x Updates from 6.x to 7.x
* @{
+ * Update functions from 6.x to 7.x.
*/
/**
diff --git a/modules/taxonomy/taxonomy.module b/modules/taxonomy/taxonomy.module
index d7417928e..459affa7e 100644
--- a/modules/taxonomy/taxonomy.module
+++ b/modules/taxonomy/taxonomy.module
@@ -1622,6 +1622,8 @@ function taxonomy_rdf_mapping() {
/**
* @defgroup taxonomy indexing Taxonomy functions maintaining {taxonomy_index}.
+ * @{
+ * Functions to maintain taxonomy indexing.
*
* Taxonomy uses default field storage to store canonical relationships
* between terms and fieldable entities. However its most common use case
@@ -1634,7 +1636,6 @@ function taxonomy_rdf_mapping() {
* field storage engines or alternative methods of denormalizing this data
* you should set the variable 'taxonomy_maintain_index_table' to FALSE
* to avoid unnecessary writes in SQL.
- * @{
*/
/**
diff --git a/modules/tracker/tracker.install b/modules/tracker/tracker.install
index 407109885..4ec1281ea 100644
--- a/modules/tracker/tracker.install
+++ b/modules/tracker/tracker.install
@@ -114,7 +114,7 @@ function tracker_schema() {
}
/**
- * @defgroup updates-6.x-to-7.x Tracker updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -217,6 +217,5 @@ function tracker_update_7000() {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/update/update.install b/modules/update/update.install
index b9005a24f..95688e938 100644
--- a/modules/update/update.install
+++ b/modules/update/update.install
@@ -160,7 +160,7 @@ function _update_requirement_check($project, $type) {
}
/**
- * @defgroup updates-6.x-to-7.x Filter updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -187,6 +187,5 @@ function update_update_7001() {
}
/**
- * @} End of "defgroup updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/
diff --git a/modules/update/update.manager.inc b/modules/update/update.manager.inc
index c11014af0..9ad0d08e0 100644
--- a/modules/update/update.manager.inc
+++ b/modules/update/update.manager.inc
@@ -37,8 +37,11 @@
*/
/**
- * @defgroup update_manager_update Update manager for updating existing code.
+ * @defgroup update_manager_update Update manager: update
* @{
+ * Update manager for updating existing code.
+ *
+ * Provides a user interface to update existing code.
*/
/**
@@ -436,8 +439,11 @@ function update_manager_update_ready_form_submit($form, &$form_state) {
*/
/**
- * @defgroup update_manager_install Update manager for installing new code.
+ * @defgroup update_manager_install Update manager: install
* @{
+ * Update manager for installing new code.
+ *
+ * Provides a user interface to install new code.
*/
/**
@@ -617,8 +623,12 @@ function update_manager_install_form_submit($form, &$form_state) {
*/
/**
- * @defgroup update_manager_file Update manager file management functions.
+ * @defgroup update_manager_file Update manager: file management
* @{
+ * Update manager file management functions.
+ *
+ * These functions are used by the update manager to copy, extract
+ * and verify archive files.
*/
/**
diff --git a/modules/update/update.module b/modules/update/update.module
index 6ff35f5c1..8891a5067 100644
--- a/modules/update/update.module
+++ b/modules/update/update.module
@@ -721,6 +721,7 @@ function update_verify_update_archive($project, $archive_file, $directory) {
/**
* @defgroup update_status_cache Private update status cache system
* @{
+ * Functions to manage the update status cache.
*
* We specifically do NOT use the core cache API for saving the fetched data
* about available updates. It is vitally important that this cache is only
diff --git a/modules/user/user.install b/modules/user/user.install
index 615743b8b..1884f4f03 100644
--- a/modules/user/user.install
+++ b/modules/user/user.install
@@ -393,7 +393,7 @@ function _update_7000_user_role_grant_permissions($rid, array $permissions, $mod
}
/**
- * @defgroup user-updates-6.x-to-7.x User updates from 6.x to 7.x
+ * @addtogroup updates-6.x-to-7.x
* @{
*/
@@ -855,6 +855,5 @@ function user_update_7015() {
}
/**
- * @} End of "defgroup user-updates-6.x-to-7.x"
- * The next series of updates should start at 8000.
+ * @} End of "addtogroup updates-6.x-to-7.x"
*/