- Small fixes to class documentation

- Now distcheck works correctly, including a copy of the API
documentation in the built dist tar.


git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@214 3ecf2c5c-341e-0410-92b4-d18e462d057c
This commit is contained in:
tchernobog 2006-01-26 22:41:42 +00:00
parent 955d987ff1
commit 692fc55553
7 changed files with 64 additions and 19 deletions

View file

@ -28,14 +28,13 @@
// ---------------------------------------------
//! The main program window
class MainWindow;
// ---------------------------------------------
/** This is the main simulation window displayed
/** \brief The main program window
*
* This is the main simulation window displayed
* when the program is run with a GUI */
class MainWindow : public Gtk::Window {
public:

View file

@ -23,7 +23,7 @@
#include "config.h"
//! This function starts the whole GUI
/** \brief This function starts the whole GUI */
void DLLEXPORT start_gui(int argc, char** argv);
#endif

View file

@ -21,8 +21,9 @@
#ifndef PARSEOPTS_HH
#define PARSEOPTS_HH 1
//! Parses command line options
/** Parses command line options and sets argv to the first filename
/** \brief Parses command line options
*
* Parses command line options and sets argv to the first filename
* given to the cmdline.
* If no filename is given, in the end argc will be 0
* Else argc will contain the length of the remaining argv[].
@ -34,7 +35,7 @@
*/
void parse_options(int& argc, char**& argv);
//! Prints license notice text to stderr
/** \brief Prints license notice text to stderr **/
void print_license();
#endif