Issue #1175614 by barbi, oriol_e9g, CashWilliams, aenw: improve phpdoc on block_list()

diff --git a/modules/block/block.module b/modules/block/block.module
index 9eecda7..2974ce3 100644 (file)
--- a/modules/block/block.module
+++ b/modules/block/block.module
@@ -437,14 +437,14 @@ function block_user($type, $edit, &$account, $category = NULL) {
  *   The name of a region.
  *
  * @return
- *   An array of block objects, indexed with <i>module</i>_<i>delta</i>.
- *   If you are displaying your blocks in one or two sidebars, you may check
- *   whether this array is empty to see how many columns are going to be
- *   displayed.
+ *   An array of block objects, indexed with module name and block delta
+ *   concatenated with an underscore, thus: MODULE_DELTA. If you are displaying
+ *   your blocks in one or two sidebars, you may check whether this array is
+ *   empty to see how many columns are going to be displayed.
  *
  * @todo
  *   Now that the blocks table has a primary key, we should use that as the
- *   array key instead of <i>module</i>_<i>delta</i>.
+ *   array key instead of MODULE_DELTA.
  */
 function block_list($region) {
   global $user, $theme_key;