/****************************************************************************** * * * * Copyright (C) 1997-2008 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * Documents produced by Doxygen are derivative works derived from the * input used in their production; they are not affected by this license. * */ /*! \page doxygen_usage Doxygen usage Doxygen is a command line based utility. Calling \c doxygen with the \c --help option at the command line will give you a brief description of the usage of the program. All options consist of a leading character -, followed by one character and one or more arguments depending on the option. To generate a manual for your project you typically need to follow these steps:
  1. You document your source code with special documentation blocks (see section \ref specialblock).
  2. You generate a configuration file (see section \ref config) by calling doxygen with the \c -g option: \verbatim doxygen -g \endverbatim
  3. You edit the configuration file so it matches your project. In the configuration file you can specify the input files and a lot of optional information.
  4. You let doxygen generate the documentation, based on the settings in the configuration file: \verbatim doxygen \endverbatim
If you have a configuration file generated with an older version of doxygen, you can upgrade it to the current version by running doxygen with the -u option. \verbatim doxygen -u \endverbatim All configuration settings in the original configuration file will be copied to the new configuration file. Any new options will have their default value. Note that comments that you may have added in the original configuration file will be lost. \anchor doxygen_finetune If you want to fine-tune the way the output looks, doxygen allows you generate default style sheet, header, and footer files that you can edit afterwards: Note:
*/