Commit 9b24995a authored by wiebel's avatar wiebel
Browse files

[DOC] unified and improved

parent 6f20ce52
......@@ -79,11 +79,10 @@ private:
};
/**
\defgroup dataHandler Data Handler
\brief
This module implements the data storage facility of OpenWalnut.
*/
* \defgroup dataHandler Data Handler
*
* \brief
* This module implements the data storage facility of OpenWalnut.
*/
#endif // WDATAHANDLER_H
......@@ -27,6 +27,7 @@
/**
* Dataset types and number values taken from the nifti1.h, at this point it's unknown if it makes sense
* to keep the bit coding, but it doesn't hurt either
* \ingroup dataHandler
*/
enum dataType
{
......
......@@ -33,6 +33,7 @@
* A grid that has axis aligned cuboid cells which all have the same width,
* the same height and the same depth. I.e. the samples along a single axis
* are equidistant. The distance of samples may vary between axes.
* \ingroup dataHandler
*/
class WGridRegular3D : public WGrid
{
......
......@@ -32,6 +32,7 @@ class WDataHandler;
/**
* Decouples file loading from the rest of OpenWalnut into a single thread.
* \ingroup dataHandler
*/
class WLoaderManager
{
......
......@@ -30,6 +30,7 @@
/**
* Stores meta information such as types, file names, etc. associated with a
* WDataSet loaded into OpenWalnut.
* \ingroup dataHandler
*/
class WMetaInfo
{
......
......@@ -30,6 +30,7 @@
* \par Description:
* Class for wrapping around the OSG Camera class. It adds some utility functions for simply setting some
* camera defaults.
* \ingroup ge
*/
class WGECamera: public osg::Camera
{
......
......@@ -43,6 +43,7 @@ typedef osgViewer::GraphicsWindowX11::WindowData WindowData;
/**
* \par Description:
* Class managing a single graphics context and OSG GraphicsWindow.
* \ingroup ge
*/
class WGEGraphicsWindow
{
......
......@@ -29,6 +29,7 @@
/**
* \par Description:
* Class for managing the OpenSceneGraph root node. It can handle new nodes, removing nodes and so on.
* \ingroup ge
*/
class WGEScene: public osg::Group
{
......
......@@ -45,6 +45,7 @@
* \par Description:
* Class for managing one viewer to the scene. This includes viewport, camera and graphics context.
* It is, besides WGraphicsEngine, the ONLY entry point for each widget for accessing the graphics engine.
* \ingroup ge
*/
class WGEViewer: public WGEGraphicsWindow
{
......
......@@ -25,8 +25,8 @@
#define WGLSCENEPAINTER_H
/**
* \ingroup ge
* This is the base class for rendering the scene graph.
* \ingroup ge
*/
class WGLScenePainter
{
......@@ -51,13 +51,4 @@ public:
virtual void resizeGL( int width, int height ) const;
};
/**
\defgroup ge GraphicsEngine
\brief
This module implements the graphics engine for OpenWalnut.
*/
#endif // WGLSCENEPAINTER_H
......@@ -38,6 +38,7 @@
* \par Description:
* Base class for initializing the graphics engine. This Class also serves as adaptor to access the graphics
* engine.
* \ingroup ge
*/
class WGraphicsEngine: public WThreadedRunner
{
......@@ -62,23 +63,23 @@ public:
*/
WGraphicsEngine( const WGraphicsEngine& other );
/**
/**
* \par Description
* Returns the root node of the OSG.
*
*
* \return the root node.
*/
WGEScene* getScene();
protected:
/**
/**
* \par Description
* OpenSceneGraph root node.
*/
WGEScene* m_RootNode;
/**
/**
* \par Description
* Handler for repainting and event handling. Gets executed in separate thread.
*/
......@@ -87,5 +88,12 @@ protected:
private:
};
/**
* \defgroup ge GraphicsEngine
*
* \brief
* This module implements the graphics engine for OpenWalnut.
*/
#endif // WGRAPHICSENGINE_H
......@@ -34,8 +34,8 @@ class WGUI: public WThreadedRunner
{
public:
/**
* \par Description
/**
* \par Description
* Default destructor.
*/
virtual ~WGUI();
......@@ -51,11 +51,11 @@ public:
};
/**
\defgroup gui GUI
\brief
This module implements the graphical user interface for OpenWalnut.
*/
* \defgroup gui GUI
*
* \brief
* This module implements the graphical user interface for OpenWalnut.
*
*/
#endif // WGUI_H
......@@ -28,6 +28,7 @@
/**
* Starts up the QT GUI.
* \ingroup gui
*/
class WMainApplication: public WThreadedRunner
{
......
......@@ -42,9 +42,9 @@ class WQtGLWidget;
class WQtPipelineBrowser;
/**
* \ingroup gui
* This class contains the main window and the layout
* of the widgets within the window.
* \ingroup gui
*/
class WMainWindow : public QObject, public WGUI
{
......
......@@ -36,9 +36,9 @@
#include "../../graphicsEngine/WGEViewer.h"
/**
* \ingroup gui
* A widget containing an open gl display area. This initializes OpenGL context and adds a view to the
* engine.
* \ingroup gui
*/
class WQtGLWidget: public QWidget
{
......
......@@ -27,9 +27,9 @@
#include <QtGui/QDockWidget>
/**
* \ingroup gui
* Represents the browser showing the loaded data sets
* and applied filter/methods/algorithms/plugins
* \ingroup gui
*/
class WQtPipelineBrowser: public QDockWidget
{
......
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