■ FIGURE 7. Doxygen generated SPI function.
shown in Figure 7. Click on the Todo List and you’ll get
what’s shown in Figure 8.
As we progress with developing our AVR Tools library,
we will add a few more doxygen features to the process,
keeping in mind that our goal is to make the code
documenting process as simple and easy as possible so
we will use it, but with just enough features to make the
output really useful.
Converting To The HTML
Help .chm File
You will notice that the HTML output is about 40 files
■ FIGURE 9. Doxywizard output compressed HTML.
SMILEY’S WORKSHOP ☺
■ FIGURE 8. Doxygen generated Todo list.
and that you need to click on index.html to open the
browser to access them. You can convert these files into a
single compressed HTML (.chm) file (such as the typical
Microsoft Help file shown in Figure 12).
Set Doxygen to prepare the HTML output for
compressed HTML (.chm) by selecting what’s shown in
Figure 9, then run it to create the file.
Download Microsoft HTML Help Workshop from
Open HTML Help Workshop and click ‘File\Open,’ then
browse to select the index.hhp generated by Doxygen
which will fill out the IDE as shown in Figure 10.
Click on the ‘Compile HTML file’ button as shown
in Figure 11. The results will be
index.chm. Change the name to
doxygen_test.chm and click on it
to reveal the help file shown in
You will probably want to
■ FIGURE 11.
Compile HTML file.
■ FIGURE 10. HTML Help Workshop.
January 2011 61