mainpage - /** @mainpage Examples Directory * * @section...

Info iconThis preview shows page 1. Sign up to view the full content.

View Full Document Right Arrow Icon
This is the end of the preview. Sign up to access the rest of the document.

Unformatted text preview: /** @mainpage Examples Directory * * @section Description * This documentation was automatically generated from the source code, * <a href="/~kogorman/class/f09/cpe357/examples/Doxyfile">Doxyfile</a> * and * <a href="/~kogorman/class/f09/cpe357/examples/mainpage.txt">mainpage.txt</a> * in the * <a href="/~kogorman/class/f09/cpe357/examples/examples.html">Examples</a> page. * You should note that the Doxyfile that is used in this directory is NOT * the one automatically generated by the "make Doxyfile" rule in the makefile. * It is also not the one you want to use in your projects because, among other * things, it puts the results in the wrong place. * Feel free to examine it for ideas, however. * Using the diff(1) command to compare it to the automatically generated one * can be helpful here as well. * * <p>This main page is optional, and is provided partly because in its absence, * previous classes worried because the first page appeared too empty, and * they thought they might have done something wrong. So I wanted to show * you how to do it. It's probably a good idea to have some content on the * main page.</p> * * @section Sections * You can accumulate stuff for this page from any file that is processed, * by putting the appropriate "mainpage" command in a doxygen comment. * You should probably make each such inclusion a separate section. * * @section Markup * Doxygen generates HTML 4.01 Transitional documents with Cascading Style * Sheets (CSS), and you can include * markup tags that are compatible with those * standards. This includes most of the common modern markups. */ ...
View Full Document

Ask a homework question - tutors are online