_book_toc_recurse documentation needs expansion

Yeah, that function header is not very useful at all.
http://api.drupal.org/api/function/_book_toc_recurse/7

Should also be backported to Drupal 6 after it is fixed.

Seems like a good novice project

Whoops, selected wrong tag

I looked at this but it seems like it makes more sense to document all of the arguments in that function if documenting $exclude and $mlid... removing the novice tag for now. (Maybe I'll try again when it's not so late at night!)

Nice doc writing!

Formatting has some problems:
- spaces at ends of some lines
- final */ needs to be on its own line
- return value not documented - is there one? If not, mention in @param blocks that the particular parameter is modified in place
- wrap as close to 80 characters as possible without going over

+ * @param &$toc
+ *   Reference to $toc array.

- we don't put & in the @param line (it's in the function signature only)
- 2nd line would be better s "Reference to the table of contents array.", I think? Saying $toc is a reference to $toc is not very useful. :)

Got it, thanks - I think this fixes everything you mention. :)

You need to not split words with hyphens. This documentation will be formatted differently when it's displayed on api.drupal.org, and that will cause it to appear as "incre- mented". Please just move that whole word to the next line.

Also, in this section:

+ * @param $tree
+ *   The data structure of the book's menu tree.  Includes all
+ *   links, including hidden items.

several more words could go up onto the first line, to try to wrap at as close to 80 characters as possible.

Other that those two spots, looks great, thanks!

Ah, I see. Gotcha! (And I don't know how I overlooked the too-short line. I re-checked several times, darn it.) Also tweaked wording a tiny bit for decreased redundancy.

Great!

Thanks for your work, Caligan. Committed to CVS HEAD.