From 03556d22f24b73160db98556546b6b277870128e Sat, 11 Jun 2011 10:14:06 +0200 From: Bram Goffings Date: Sat, 11 Jun 2011 10:13:57 +0200 Subject: [PATCH] Doc changes diff --git a/modules/entity/entity.controller.inc b/modules/entity/entity.controller.inc index c57b9e0..8327bc6 100644 --- a/modules/entity/entity.controller.inc +++ b/modules/entity/entity.controller.inc @@ -300,6 +300,7 @@ /** * Attaches data to entities upon loading. + * * This will attach fields, if the entity is fieldable. It calls * hook_entity_load() for modules which need to add data to all entities. * It also calls hook_TYPE_load() on the loaded entities. For example diff --git a/modules/entity/entity.module b/modules/entity/entity.module index 52d8667..e9363cb 100644 --- a/modules/entity/entity.module +++ b/modules/entity/entity.module @@ -37,7 +37,7 @@ } /** - * Get the entity info array of an entity type. + * Gets the entity info array of an entity type. * * @see hook_entity_info() * @see hook_entity_info_alter() @@ -132,6 +132,7 @@ * The entity type; e.g. 'node' or 'user'. * @param $entity * The entity from which to extract values. + * * @return * A numerically indexed array (not a hash table) containing these * elements: @@ -163,6 +164,7 @@ * 0: primary id of the entity * 1: revision id of the entity, or NULL if $entity_type is not versioned * 2: bundle name of the entity, or NULL if $entity_type has no bundles + * * @return * An entity structure, initialized with the ids provided. */ @@ -180,7 +182,7 @@ } /** - * Load entities from the database. + * Loads entities from the database. * * This function should be used whenever you need to load more than one entity * from the database. The entities are loaded into memory and will not require @@ -247,7 +249,7 @@ } /** - * Get the entity controller class for an entity type. + * Gets the entity controller class for an entity type. */ function entity_get_controller($entity_type) { $controllers = &drupal_static(__FUNCTION__, array()); @@ -260,7 +262,7 @@ } /** - * Invoke hook_entity_prepare_view(). + * Invokes hook_entity_prepare_view(). * * If adding a new entity similar to nodes, comments or users, you should * invoke this function during the ENTITY_build_content() or @@ -272,6 +274,7 @@ * recursion. By convention, entity_prepare_view() is called after * field_attach_prepare_view() to allow entity level hooks to act on content * loaded by field API. + * * @see hook_entity_prepare_view() * * @param $entity_type @@ -306,6 +309,7 @@ * The entity type; e.g. 'node' or 'user'. * @param $entity * The entity for which to generate a path. + * * @return * An array containing the 'path' and 'options' keys used to build the uri of * the entity, and matching the signature of url(). NULL if the entity has no diff --git a/modules/entity/entity.query.inc b/modules/entity/entity.query.inc index 0823d57..2501002 100644 --- a/modules/entity/entity.query.inc +++ b/modules/entity/entity.query.inc @@ -458,7 +458,7 @@ } /** - * Enable a pager for the query. + * Enables a pager for the query. * * @param $limit * An integer specifying the number of elements per page. If passed a false @@ -486,7 +486,7 @@ } /** - * Enable sortable tables for this query. + * Enables sortable tables for this query. * * @param $headers * An EFQ Header array based on which the order clause is added to the query. @@ -763,7 +763,7 @@ } /** - * Get the total number of results and initialize a pager for the query. + * Gets the total number of results and initialize a pager for the query. * * This query can be detected by checking for ($this->pager && $this->count), * which allows a driver to return 0 from the count query and disable