Commit 8b549ce8 authored by Ulrich Kemloh's avatar Ulrich Kemloh

Sample header documentation

parent 5fc8b20e
/**
* \file Simulation.h
* \date Dec 15, 2010
* \version MAJOR.MINOR
* \file Simulation.h
* \date Dec 15, 2010
* \version v0.5
* \copyright <2009-2014> Forschungszentrum Jülich GmbH. All rights reserved.
*
* Copyright (C) <2009-2014>
*
* \section LICENSE
* \section License
* This file is part of JuPedSim.
*
* JuPedSim is free software: you can redistribute it and/or modify
......@@ -21,12 +20,15 @@
* You should have received a copy of the GNU General Public License
* along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
*
* \section description
* \section Description
* The Simulation class represents a simulation of pedestrians
* based on a certain model in a specific scenario. A simulation is defined by
* various parameters and functions.
*
*/
*
**/
#ifndef SIMULATION_H_
#define SIMULATION_H_
......@@ -52,6 +54,7 @@
extern OutputHandler* Log;
class Simulation {
private:
///Number of pedestrians in the simulation
......@@ -83,7 +86,14 @@ private:
public:
/**
* constructor
*/
Simulation();
/**
* Destructor
*/
virtual ~Simulation();
/**
......@@ -123,7 +133,6 @@ public:
*/
void Update();
/**
* print some statistics about the simulation
*/
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment