diff options
| author | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-09-14 08:23:41 -0700 |
|---|---|---|
| committer | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-09-14 08:23:41 -0700 |
| commit | 722b042d1f3c2e0001329eeba5575960ce9efbd1 (patch) | |
| tree | 97532a151f2f9408968ef4bfe4b70f51b484800a /includes/common.inc | |
| parent | b2daf814f093db0638385bec893af3dcb7bbeaa5 (diff) | |
| download | brdo-722b042d1f3c2e0001329eeba5575960ce9efbd1.tar.gz brdo-722b042d1f3c2e0001329eeba5575960ce9efbd1.tar.bz2 | |
Issue #863428 by Albert Volkman, Mile23: Fix up documentation for block cache constants
Diffstat (limited to 'includes/common.inc')
| -rw-r--r-- | includes/common.inc | 11 |
1 files changed, 8 insertions, 3 deletions
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 @@ -156,6 +157,10 @@ define('DRUPAL_CACHE_PER_PAGE', 0x0004); define('DRUPAL_CACHE_GLOBAL', 0x0008); /** + * @} End of "defgroup block_caching". + */ + +/** * Adds content to a specified region. * * @param $region |