Commit f5beef8a authored by VAN TOLL Wouter's avatar VAN TOLL Wouter

Added a Doxygen summary of the new GUI-related classes.

parent 390bd5b8
......@@ -30,6 +30,9 @@
class UMANSQtGuiApplication;
/// <summary>Contains the visualization and behavior of the UMANS GUI application.
/// This class includes functions for drawing simulation details on the screen,
/// and functions that respond to interaction with UI elements.</summary>
class UMANSOpenGLWidget : public QOpenGLWidget
{
Q_OBJECT
......@@ -110,9 +113,7 @@ private:
bool makeScreenshotsPerFrame;
bool writeCSVOutput;
/// <summary>
/// The part of the world that is currently being shown in the OpenGL widget.
/// </summary>
/// <summary>The part of the world that is currently being shown in the OpenGL widget.</summary>
QRectF viewBounds;
/// <summary>The width and height of theis OpenGL widget, in pixels.</summary>
......
......@@ -27,6 +27,7 @@
class OGLWidget;
/// <summary>Wrapper for the UMANS GUI application.</summary>
class UMANSQtGuiApplication : public QWidget
{
Q_OBJECT
......
......@@ -26,6 +26,8 @@
#include <QOpenGLVertexArrayObject>
#include <QOpenGLBuffer>
/// <summary>A struct that can contain data to be shown on the screen.
/// Used by the UMANSOpenGLWidget class in the UMANS GUI application.</summary>
struct VisualizationData
{
private:
......
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