Commit 7264290e authored by webchick's avatar webchick
Browse files

#987384 by h_peter, jhodgdon: Fixed Topics/groups in D7 need cleanup

parent d30dd061
......@@ -9,6 +9,8 @@
/**
* @defgroup ajax AJAX framework
* @{
* Functions for Drupal's AJAX framework.
*
* Drupal's AJAX framework is used to dynamically update parts of a page's HTML
* based on data from the server. Upon a specified event, such as a button
* click, a callback function is triggered which performs server-side logic and
......@@ -696,6 +698,10 @@ function ajax_pre_render_element($element) {
/**
* @defgroup ajax_commands AJAX framework commands
* @{
* Functions to create various AJAX commands.
*
* These functions can be used to create arrays for use with the
* ajax_render() function.
*/
/**
......
......@@ -9,6 +9,8 @@
/**
* @defgroup image Image toolkits
* @{
* Functions for image file manipulations.
*
* Drupal's image toolkits provide an abstraction layer for common image file
* manipulations like scaling, cropping, and rotating. The abstraction frees
* module authors from the need to support multiple image libraries, and it
......
......@@ -70,6 +70,10 @@
/**
* @defgroup locale-languages-negotiation Language negotiation options
* @{
* Functions for language negotiation.
*
* There are functions that provide the ability to identify the
* language. This behavior can be controlled by various options.
*/
/**
......@@ -422,6 +426,9 @@ function locale_string_is_safe($string) {
/**
* @defgroup locale-api-add Language addition API.
* @{
* Add a language.
*
* The language addition API is used to create languages and store them.
*/
/**
......@@ -498,8 +505,12 @@ function locale_add_language($langcode, $name = NULL, $native = NULL, $direction
*/
/**
* @defgroup locale-api-import Translation import API.
* @defgroup locale-api-import-export Translation import/export API.
* @{
* Functions to import and export translations.
*
* These functions provide the ability to import translations from
* external files and to export translations and translation templates.
*/
/**
......@@ -1274,7 +1285,7 @@ function _locale_import_parse_quoted($string) {
}
}
/**
* @} End of "locale-api-import"
* @} End of "locale-api-import-export"
*/
/**
......@@ -1347,7 +1358,7 @@ function _locale_parse_js_file($filepath) {
}
/**
* @defgroup locale-api-export Translation (template) export API.
* @addtogroup locale-api-import-export
* @{
*/
......@@ -1584,12 +1595,16 @@ function _locale_export_remove_plural($entry) {
return preg_replace('/(@count)\[[0-9]\]/', '\\1', $entry);
}
/**
* @} End of "locale-api-export"
* @} End of "locale-api-import-export"
*/
/**
* @defgroup locale-api-seek String search functions.
* @defgroup locale-api-seek Translation search API.
* @{
* Functions to search in translation files.
*
* These functions provide the functionality to search for specific
* translations.
*/
/**
......@@ -1894,6 +1909,7 @@ function _locale_translate_language_list($translation, $limit_language) {
/**
* @defgroup locale-api-predefined List of predefined languages
* @{
* API to provide a list of predefined languages.
*/
/**
......@@ -1928,6 +1944,10 @@ function _locale_prepare_predefined_list() {
/**
* @defgroup locale-autoimport Automatic interface translation import
* @{
* Functions to create batches for importing translations.
*
* These functions can be used to import translations for installed
* modules.
*/
/**
......
......@@ -7,8 +7,10 @@
*/
/**
* @defgroup lock Functions to coordinate long-running operations across requests.
* @defgroup lock Locking mechanisms
* @{
* Functions to coordinate long-running operations across requests.
*
* In most environments, multiple Drupal page requests (a.k.a. threads or
* processes) will execute in parallel. This leads to potential conflicts or
* race conditions when two requests execute the same code at the same time. A
......
......@@ -209,7 +209,7 @@ function update_prepare_d7_bootstrap() {
db_create_table('registry_file', $schema['registry_file']);
}
// Older versions of Drupal 6 do not include the semaphore table, which is
// Older versions of Drupal 6 do not include the semaphore table, which is
// required to bootstrap, so we add it now so that we can bootstrap and
// provide a reasonable error message.
if (!db_table_exists('semaphore')) {
......
......@@ -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"
*/
......@@ -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"
*/
/**
......
......@@ -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"
*/
......@@ -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"
*/
......@@ -6,201 +6,6 @@
* Field CRUD API, handling field and field instance creation and deletion.
*/
/**
* @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
* @{
......@@ -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']);
......
......@@ -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"
*/
......@@ -38,7 +38,191 @@ class FieldException extends Exception {}
* 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.