summaryrefslogtreecommitdiff
path: root/modules/book/book.pages.inc
diff options
context:
space:
mode:
Diffstat (limited to 'modules/book/book.pages.inc')
-rw-r--r--modules/book/book.pages.inc74
1 files changed, 41 insertions, 33 deletions
diff --git a/modules/book/book.pages.inc b/modules/book/book.pages.inc
index 1617f0085..5a05c9f1d 100644
--- a/modules/book/book.pages.inc
+++ b/modules/book/book.pages.inc
@@ -6,7 +6,7 @@
*/
/**
- * Menu callback; prints a listing of all books.
+ * Menu callback: Prints a listing of all books.
*/
function book_render() {
$book_list = array();
@@ -18,25 +18,24 @@ function book_render() {
}
/**
- * Menu callback; Generates various representation of a book page and its children.
+ * Menu callback; Generates representations of a book page and its children.
*
- * The function delegates the generation of output to helper functions.
- * The function name is derived by prepending 'book_export_' to the
- * given output type. So, e.g., a type of 'html' results in a call to
- * the function book_export_html().
+ * The function delegates the generation of output to helper functions. The
+ * function name is derived by prepending 'book_export_' to the given output
+ * type. So, e.g., a type of 'html' results in a call to the function
+ * book_export_html().
*
* @param $type
- * A string encoding the type of output requested. The following
- * types are currently supported in book module:
- *
- * - html: HTML (printer friendly output)
- *
+ * A string encoding the type of output requested. The following types are
+ * currently supported in book module:
+ * - html: Printer-friendly HTML.
* Other types may be supported in contributed modules.
* @param $nid
* An integer representing the node id (nid) of the node to export
+ *
* @return
- * A string representing the node and its children in the book hierarchy
- * in a format determined by the $type parameter.
+ * A string representing the node and its children in the book hierarchy in a
+ * format determined by the $type parameter.
*/
function book_export($type, $nid) {
$type = drupal_strtolower($type);
@@ -53,18 +52,18 @@ function book_export($type, $nid) {
}
/**
- * This function is called by book_export() to generate HTML for export.
+ * Generates HTML for export when invoked by book_export().
*
- * The given node is /embedded to its absolute depth in a top level
- * section/. For example, a child node with depth 2 in the hierarchy
- * is contained in (otherwise empty) <div> elements
- * corresponding to depth 0 and depth 1. This is intended to support
- * WYSIWYG output - e.g., level 3 sections always look like level 3
- * sections, no matter their depth relative to the node selected to be
- * exported as printer-friendly HTML.
+ * The given node is embedded to its absolute depth in a top level section. For
+ * example, a child node with depth 2 in the hierarchy is contained in
+ * (otherwise empty) <div> elements corresponding to depth 0 and depth 1.
+ * This is intended to support WYSIWYG output - e.g., level 3 sections always
+ * look like level 3 sections, no matter their depth relative to the node
+ * selected to be exported as printer-friendly HTML.
*
* @param $nid
* An integer representing the node id (nid) of the node to export.
+ *
* @return
* A string containing HTML representing the node and its children in
* the book hierarchy.
@@ -88,7 +87,10 @@ function book_export_html($nid) {
}
/**
- * Menu callback; show the outline form for a single node.
+ * Menu callback: Shows the outline form for a single node.
+ *
+ * @param $node
+ * The book node for which to show the outline.
*/
function book_outline($node) {
drupal_set_title($node->title);
@@ -96,11 +98,15 @@ function book_outline($node) {
}
/**
- * Build the form to handle all book outline operations via the outline tab.
+ * Form constructor for the book outline form.
+ *
+ * Allows handling of all book outline operations via the outline tab.
+ *
+ * @param $node
+ * The book node for which to show the outline.
*
* @see book_outline_form_submit()
* @see book_remove_button_submit()
- *
* @ingroup forms
*/
function book_outline_form($form, &$form_state, $node) {
@@ -140,18 +146,20 @@ function book_outline_form($form, &$form_state, $node) {
}
/**
- * Button submit function to redirect to removal confirm form.
+ * Form submission handler for book_outline_form().
+ *
+ * Redirects to removal confirmation form.
*
- * @see book_outline_form()
+ * @see book_outline_form_submit()
*/
function book_remove_button_submit($form, &$form_state) {
$form_state['redirect'] = 'node/' . $form['#node']->nid . '/outline/remove';
}
/**
- * Handles book outline form submissions from the outline tab.
+ * Form submission handler for book_outline_form().
*
- * @see book_outline_form()
+ * @see book_remove_button_submit()
*/
function book_outline_form_submit($form, &$form_state) {
$node = $form['#node'];
@@ -181,10 +189,12 @@ function book_outline_form_submit($form, &$form_state) {
}
/**
- * Menu callback; builds a form to confirm removal of a node from the book.
+ * Form constructor to confirm removal of a node from a book.
*
- * @see book_remove_form_submit()
+ * @param $node
+ * The node to delete.
*
+ * @see book_remove_form_submit()
* @ingroup forms
*/
function book_remove_form($form, &$form_state, $node) {
@@ -202,9 +212,7 @@ function book_remove_form($form, &$form_state, $node) {
}
/**
- * Confirm form submit function to remove a node from the book.
- *
- * @see book_remove_form()
+ * Form submission handler for book_remove_form().
*/
function book_remove_form_submit($form, &$form_state) {
$node = $form['#node'];