From 722b042d1f3c2e0001329eeba5575960ce9efbd1 Mon Sep 17 00:00:00 2001 From: Jennifer Hodgdon Date: Fri, 14 Sep 2012 08:23:41 -0700 Subject: Issue #863428 by Albert Volkman, Mile23: Fix up documentation for block cache constants --- includes/common.inc | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'includes/common.inc') diff --git a/includes/common.inc b/includes/common.inc index 8f5e13a78..8ae051738 100644 --- a/includes/common.inc +++ b/includes/common.inc @@ -92,11 +92,12 @@ define('JS_THEME', 100); define('HTTP_REQUEST_TIMEOUT', -1); /** - * Constants defining cache granularity for blocks and renderable arrays. + * @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(): - * $block[delta]['cache'] = DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE; + * combinations of these constants in their hook_block_info(). * DRUPAL_CACHE_PER_ROLE is used as a default when no caching pattern is * specified. Use DRUPAL_CACHE_CUSTOM to disable standard block cache and * implement @@ -155,6 +156,10 @@ define('DRUPAL_CACHE_PER_PAGE', 0x0004); */ define('DRUPAL_CACHE_GLOBAL', 0x0008); +/** + * @} End of "defgroup block_caching". + */ + /** * Adds content to a specified region. * -- cgit v1.2.3