summaryrefslogtreecommitdiff
path: root/modules/book
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2010-04-13 15:23:03 +0000
committerDries Buytaert <dries@buytaert.net>2010-04-13 15:23:03 +0000
commit3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d (patch)
tree4bd9c67db94feb06249cc2727dd3a5e935f58e12 /modules/book
parentf8e14898d636ceae44a9980105da903f57d2deef (diff)
downloadbrdo-3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d.tar.gz
brdo-3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d.tar.bz2
- Patch #716496 by JohnAlbin: documentation updates for theme functions.
Diffstat (limited to 'modules/book')
-rw-r--r--modules/book/book.admin.inc8
-rw-r--r--modules/book/book.module6
2 files changed, 11 insertions, 3 deletions
diff --git a/modules/book/book.admin.inc b/modules/book/book.admin.inc
index d185b0836..7a319430a 100644
--- a/modules/book/book.admin.inc
+++ b/modules/book/book.admin.inc
@@ -212,10 +212,14 @@ function _book_admin_table_tree($tree, &$form) {
}
/**
- * Theme function for the book administration page form.
+ * Returns HTML for a book administration form.
+ *
+ * @param $variables
+ * An associative array containing:
+ * - form: A render element representing the form.
*
- * @ingroup themeable
* @see book_admin_table()
+ * @ingroup themeable
*/
function theme_book_admin_table($variables) {
$form = $variables['form'];
diff --git a/modules/book/book.module b/modules/book/book.module
index 9d5938331..31401958f 100644
--- a/modules/book/book.module
+++ b/modules/book/book.module
@@ -338,7 +338,11 @@ function book_block_save($delta = '', $edit = array()) {
}
/**
- * Generate the HTML output for a link to a book title when used as a block title.
+ * Returns HTML for a link to a book title when used as a block title.
+ *
+ * @param $variables
+ * An associative array containing:
+ * - link: An array containing title, href and options for the link.
*
* @ingroup themeable
*/