summaryrefslogtreecommitdiff
path: root/modules/book/book.admin.inc
diff options
context:
space:
mode:
Diffstat (limited to 'modules/book/book.admin.inc')
-rw-r--r--modules/book/book.admin.inc15
1 files changed, 11 insertions, 4 deletions
diff --git a/modules/book/book.admin.inc b/modules/book/book.admin.inc
index 62c6e841a..cc3f08fc8 100644
--- a/modules/book/book.admin.inc
+++ b/modules/book/book.admin.inc
@@ -2,11 +2,16 @@
/**
* @file
- * Admin page callbacks for the book module.
+ * Administration page callbacks for the Book module.
*/
/**
* Returns an administrative overview of all books.
+ *
+ * @return string
+ * A HTML-formatted string with the administrative page content.
+ *
+ * @see book_menu()
*/
function book_admin_overview() {
$rows = array();
@@ -53,6 +58,8 @@ function book_admin_settings() {
/**
* Form validation handler for book_admin_settings().
+ *
+ * @see book_admin_settings_submit()
*/
function book_admin_settings_validate($form, &$form_state) {
$child_type = $form_state['values']['book_child_type'];
@@ -149,7 +156,7 @@ function book_admin_edit_submit($form, &$form_state) {
* @param $node
* The node of the top-level page in the book.
* @param $form
- * The form that is being modified.
+ * The form that is being modified, passed by reference.
*
* @see book_admin_edit()
*/
@@ -184,10 +191,10 @@ function _book_admin_table($node, &$form) {
* @param $tree
* A subtree of the book menu hierarchy.
* @param $form
- * The form that is being modified.
+ * The form that is being modified, passed by reference.
*
* @return
- * The form that is being modified.
+ * The modified form array.
*
* @see book_admin_edit()
*/