diff --git a/core/includes/common.inc b/core/includes/common.inc index 9810060..16c96aa 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -104,13 +104,9 @@ const JS_SETTING = 200; const HTTP_REQUEST_TIMEOUT = -1; /** - * The block should not get cached. - * - * This setting should be used: - * - For simple blocks (notably those that do not perform any db query), where - * querying the db cache would be more expensive than directly generating the - * content. - * - For blocks that change too frequently. + * @defgroup block_caching Block Caching + * @{ + * Constants that define each block's caching state. * * Modules specify the caching patterns for their blocks using binary * combinations of these constants in their hook_block_info(). @@ -126,6 +122,16 @@ const HTTP_REQUEST_TIMEOUT = -1; * * Note that user 1 is excluded from block caching. */ + +/** + * The block should not get cached. + * + * This setting should be used: + * - For simple blocks (notably those that do not perform any db query), where + * querying the db cache would be more expensive than directly generating the + * content. + * - For blocks that change too frequently. + */ const DRUPAL_NO_CACHE = -1; /** @@ -164,6 +170,10 @@ const DRUPAL_CACHE_PER_PAGE = 0x0004; const DRUPAL_CACHE_GLOBAL = 0x0008; /** + * @} End of "defgroup block_caching". + */ + +/** * The delimiter used to split plural strings. * * This is the ETX (End of text) character and is used as a minimal means to