■ FIGURE 3. Doxywizard project.
in the bin file. This application provides a GUI front-end
for doxygen that helps simplify using it. Open it and fill
out the project information as shown in Figure 3. In our
case, we will be creating html documentation for the SPI
functions in doxygen_test [in Workshop30.zip].
Click Next and set the mode as shown in Figure 4.
Click Next again, and set the output as shown in Figure 5.
Click Next, but skip the Diagrams and you get what
you see in Figure 6 where you will click on the ‘Run
doxygen’ and doxygen will generate your html files. Clicking
on ‘Show HTML output’ will open your default browser
with the files as shown in Figure 2. After you have finished
playing with doxygen and are ready to close it, it will ask if
you want to save the configuration file ‘Doxyfile’ – which
you do. So, save it along with the rest of your project and
■ FIGURE 5. Doxywizard output.
■ FIGURE 4. Doxywizard mode.
then if you want to change anything, the next time you
run doxygen you can use the File menu to open the
existing Doxyfile, and save time filling in the wizard boxes.
Looking At The Doxygen
Quite frankly, I was shocked the first time I ran
through this because the doxygen generated output
document looks surprisingly good. It makes you want to
go back to the code and spiff it up a bit just so it won’t be
embarrassed to be seen with such classy documentation.
You’ve seen the main page in Figure 2, so play with it a
bit to see what you’ve really got. In the frame on the left,
click on the SPI file and you’ll see the functions listed as
■ FIGURE 6. Doxywizard run.