1 2THE HAIKU BOOK HOWTO 3 4The end user documentation for Haiku is automatically generated from the 5source code using the Doxygen tool. We are talking BeBook-style documentation 6here, not development related docs (those belong in trunk/docs/develop). 7 8This HOWTO only explains how to include your kit into the "Haiku Book", it 9is not a Doxygen tutorial. For information about using Doxygen, see the Doxygen 10manual, www.doxygen.org, and OpenBeOS newletters 31 and 29. 11 12There are two ways to document your kit: 13 14 1) Put the Doxygen comments in your headers and/or source files. 15 2) Put the Doxygen comments in separate files. 16 17Either way is fine. The documentation for the Midi Kit, for example, uses the 18latter option. The files with the Doxygen comments all live in the midi2 subdir 19of trunk/docs/user. Of course, if you embed the Doxygen comments directly in 20your source code, you don't need to make a subdir in trunk/docs/user. 21 22There is one Doxygen config file (Doxyfile) for the entire book, so you don't 23have to make your own Doxyfile. You just have to add the directories with your 24commented files to the INPUT directive, so doxygen will know where to find them. 25You probably also want to add a link to your kit on the main page (book.dox). 26 27To generate the docs, simply type "doxygen" in the Terminal. The script puts 28the resulting HTML docs in "trunk/generated/doxygen/html". 29 30Note: theoretically, Doxygen allows us to treat each kit as a separate "module", 31using the \defgroup and \ingroup tags. In practice, the results of this are a 32little disappointing. That's why, at least for the time being, we simply lump 33everything together, and give each kit one or more \page's. Feel free to take a 34peek at the Midi Kit docs to figure out what the hell that means ;-) 35