Further clean up of API docs for Book module

This patch has no problems, so I committed it to 8.x and the .js file part to 7.x (the css file does not exist there). Thanks! Leaving open for further work if necessary.

Thanks, most of this looks good! A few updates needed:

a) In book.admin.inc:

- *   The form that is being modified.
+ *   The form that is being modified, passed by reference

Needs . at end of line.

b) in book.install:

/**
- * Move book settings from variables to config.
+ * Move Book settings from variables to config.

Only capitalize Book in "the Book module". I guess here it should say "Move Book module settings...". Also check other capitalization changes, such as in the BookTest.php file.

d) book.module

+ * @return
+ *   A Boolean TRUE if the current user has the requested permission.
+ *
  * @see book_menu()
  */
 function _book_outline_access(Node $node) {

By convention we do not include return value docs for hook_menu access callbacks (there are 3 in this patch).

e) book.module

/**
  * Processes variables for book-node-export-html.tpl.php.
  *
- * The $variables array contains the following elements:
- * - node
- * - children
+ * @param array $variables
+ *   An associative array containing the following keys:
+ *   - node

- children got left out - was that intentional?

f) BookTest.php

+   * @param array $nodes
+   *   An array of Nodes to check in outline.
    *
-   * @param array $nodes Nodes to check in outline.
+   * @return string
+   *   A customized regular expression as a string.
    */
   function generateOutlinePattern($nodes) {

Nodes should not be capitalized in the @param description? And the @return docs don't actually tell me what the regexp is for -- and of course it's a string (that is how regexps are in PHP), so that's not useful information.

g)_ same file

+   *   (optional) Parent book reference id. Defaults to NULL.
    */
   function createBookNode($book_nid, $parent = NULL) {

id -> ID

Addressed issue raised in #4 and found a few others.

Thanks! This one looks good, and I committed it to 8.x. I guess we should port it to 7.x -- careful though, as there are references to the Node class etc. which don't exist in 7.x.

Looks good to me! I'll get it committed soon. (Only one pass on this one -- great!)

It's in -- thanks!