/****************************************************************************** * * $Id$ * * Copyright (C) 1997-1999 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. * * All output generated with Doxygen is not covered by this license. * */ /*! \page doxygen_usage Doxygen usage Doxygen is a command line based utility. Calling \c doxygen with the \c -h 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 optionally an argument. To generate a class browser you typically need to follow these steps:
  1. You document your source code with special documentation blocks.
  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
The \c -s option is optional and can be used suppress the description that doxygen normally generates for each tag. Try to use this option if you send me configuration files! If you also want to use the search engine, you should look at section \ref doxysearch_usage. */