Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
OpenWalnut
OpenWalnut Core
Commits
224f430a
Commit
224f430a
authored
Sep 07, 2009
by
wiebel
Browse files
[DOC] removed "\par Description" as it confused doxygen and made it not show
the short descriptions
parent
269e15a1
Changes
18
Hide whitespace changes
Inline
Side-by-side
Showing
18 changed files
with
2 additions
and
128 deletions
+2
-128
src/common/WException.h
src/common/WException.h
+1
-7
src/common/WSegmentationFault.h
src/common/WSegmentationFault.h
+0
-6
src/common/WThreadedRunner.h
src/common/WThreadedRunner.h
+0
-10
src/common/test/WException_test.h
src/common/test/WException_test.h
+0
-1
src/graphicsEngine/WGECamera.h
src/graphicsEngine/WGECamera.h
+1
-8
src/graphicsEngine/WGEGraphicsWindow.h
src/graphicsEngine/WGEGraphicsWindow.h
+0
-13
src/graphicsEngine/WGEScene.h
src/graphicsEngine/WGEScene.h
+0
-2
src/graphicsEngine/WGEViewer.h
src/graphicsEngine/WGEViewer.h
+0
-13
src/graphicsEngine/WGraphicsEngine.h
src/graphicsEngine/WGraphicsEngine.h
+0
-6
src/graphicsEngine/exceptions/WGEException.h
src/graphicsEngine/exceptions/WGEException.h
+0
-3
src/graphicsEngine/exceptions/WGEInitFailed.h
src/graphicsEngine/exceptions/WGEInitFailed.h
+0
-3
src/gui/WGUI.h
src/gui/WGUI.h
+0
-1
src/gui/qt4/WMainApplication.h
src/gui/qt4/WMainApplication.h
+0
-3
src/gui/qt4/WQtGLWidget.h
src/gui/qt4/WQtGLWidget.h
+0
-20
src/kernel/WKernel.cpp
src/kernel/WKernel.cpp
+0
-1
src/kernel/WKernel.h
src/kernel/WKernel.h
+0
-19
src/kernel/WModule.h
src/kernel/WModule.h
+0
-6
src/kernel/WTestModule.h
src/kernel/WTestModule.h
+0
-6
No files found.
src/common/WException.h
View file @
224f430a
...
...
@@ -30,7 +30,6 @@
#include <sstream>
/**
* \par Description:
* Basic exception handler.
*/
class
WException
:
public
std
::
exception
...
...
@@ -43,35 +42,30 @@ friend class WExceptionTest;
public:
/**
* \par Description
* Default constructor.
* \param msg Exception description.
*/
explicit
WException
(
const
std
::
string
&
msg
=
std
::
string
()
);
/**
* \par Description
* Destructor.
*/
virtual
~
WException
()
throw
();
/**
* \par Description
* Returns the message string set on throw
* \return Message text
*/
virtual
const
char
*
what
()
const
throw
();
/**
* \par Description
* Prints the trace of the call chain which caused this exception.
* \return Calltrace as string
* \note Isn't this useless? Should be removed.
*/
std
::
string
getTrace
(
)
const
;
/**
* \par Description
/**
* Returns a call stacktrace.
* \return The backtrace at the moment of "throw".
*/
...
...
src/common/WSegmentationFault.h
View file @
224f430a
...
...
@@ -39,7 +39,6 @@
// This is highly platform dependent. Used for backtrace functionality.
/**
* \par Description
* Template class for every signal which can be handled.
*/
template
<
class
SignalExceptionClass
>
class
SignalTranslator
...
...
@@ -71,7 +70,6 @@ private:
#endif // __linux__
/**
* \par Description:
* Base exception class for handling segmentation faults.
* It throws segmentation faults as exceptions. Please remember that SIGSEGV is not
* recoverable, which means it can NOT be catched!
...
...
@@ -82,26 +80,22 @@ class WSegmentationFault: public WException
public:
/**
* \par Description
* Default constructor.
*/
explicit
WSegmentationFault
(
const
std
::
string
&
msg
=
"Segmentation Fault"
);
/**
* \par Description
* Destructor.
*/
virtual
~
WSegmentationFault
()
throw
();
/**
* \par Description
* Defines signal type to handle.
* @return The signal number.
*/
static
int
getSignalNumber
()
throw
();
/**
* \par Description
* Installs this exception as signal handler for SIGSEGV.
* This will just work on Linux.
*/
...
...
src/common/WThreadedRunner.h
View file @
224f430a
...
...
@@ -27,7 +27,6 @@
#include <boost/thread/thread.hpp>
/**
* \par Description:
* Base class for all classes needing to be executed in a separate thread.
*/
class
WThreadedRunner
...
...
@@ -35,25 +34,21 @@ class WThreadedRunner
public:
/**
* \par Description
* Default constructor.
*/
WThreadedRunner
();
/**
* \par Description
* Destructor.
*/
virtual
~
WThreadedRunner
();
/**
* \par Description
* Run thread.
*/
void
run
();
/**
* \par Description
* Wait for the thread to be finished.
*
* \param requestFinish true if the thread should be notified.
...
...
@@ -63,32 +58,27 @@ public:
protected:
/**
* \par Description
* Function that has to be overwritten for execution. It gets executed in a separate thread after run()
* has been called.
*/
virtual
void
threadMain
();
/**
* \par Description
* Thread instance.
*/
boost
::
thread
*
m_Thread
;
/**
* \par Description
* True if thread should end execution.
*/
bool
m_FinishRequested
;
/**
* \par Description
* Give remaining execution timeslice to another thread.
*/
void
yield
()
const
;
/**
* \par Description
* Sets thread asleep.
*
* \param t time to sleep in seconds.
...
...
src/common/test/WException_test.h
View file @
224f430a
...
...
@@ -32,7 +32,6 @@
#include "../WException.h"
/**
* \par Description
* Test WException
*/
class
WExceptionTest
:
public
CxxTest
::
TestSuite
...
...
src/graphicsEngine/WGECamera.h
View file @
224f430a
...
...
@@ -36,7 +36,6 @@ class WGECamera: public osg::Camera
public:
/**
* \par Description
* List of possible camera modes.
*/
enum
ProjectionMode
...
...
@@ -45,13 +44,11 @@ public:
};
/**
* \par Description
* Default constructor.
*/
WGECamera
();
/**
* \par Description
/**
* Sets the default projection mode used for cameras getting reset.
*
* \param mode the mode to set.
...
...
@@ -59,7 +56,6 @@ public:
void
setDefaultProjectionMode
(
ProjectionMode
mode
);
/**
* \par Description
* Returns the current default projection mode.
*
* \return the currently set mode.
...
...
@@ -67,7 +63,6 @@ public:
ProjectionMode
getDefaultProjectionMode
();
/**
* \par Description
* Resets the camera and activates the prior set defaults.
*/
void
reset
();
...
...
@@ -77,7 +72,6 @@ public:
protected:
/**
* \par Description
* Destructor. This desctructor is protected to avoid accidentally deleting a instance of WGECamera.
* This follows the philosophy of OSG to avoid problems in multithreaded environments, since these camera
* pointers are used deep in the OSG where an deletion could cause a segfault.
...
...
@@ -85,7 +79,6 @@ protected:
virtual
~
WGECamera
();
/**
* \par Description
* The projection mode used as default.
*/
ProjectionMode
m_DefProjMode
;
...
...
src/graphicsEngine/WGEGraphicsWindow.h
View file @
224f430a
...
...
@@ -49,7 +49,6 @@ class WGEGraphicsWindow
public:
/**
* \par Description
* Default constructor.
*
* \param wdata the WindowData instance for the widget to use as render widget
...
...
@@ -62,13 +61,11 @@ public:
WGEGraphicsWindow
(
boost
::
shared_ptr
<
WindowData
>
wdata
,
int
x
,
int
y
,
int
width
,
int
height
);
/**
* \par Description
* Destructor.
*/
virtual
~
WGEGraphicsWindow
();
/**
* \par Description
* Getter for m_GraphicsWindow.
*
* \return the OSG GraphicsWindow instance.
...
...
@@ -76,7 +73,6 @@ public:
boost
::
shared_ptr
<
osgViewer
::
GraphicsWindow
>
getGraphicsWindow
();
/**
* \par Description
* Event types for the keyEvent() handler.
*/
enum
KeyEvents
...
...
@@ -85,7 +81,6 @@ public:
};
/**
* \par Description
* Mouse event types for the mouseEvent() handler.
*/
enum
MouseEvents
...
...
@@ -94,7 +89,6 @@ public:
};
/**
* \par Description
* Updates size information.
*
* \param width new width.
...
...
@@ -103,14 +97,12 @@ public:
virtual
void
resize
(
int
width
,
int
height
);
/**
* \par Description
* Initiates a close event for this viewer. It destroys the graphics context and invalidates the viewer.
* This should be called whenever a QT Widget closes to also free its OSG Viewer resources.
*/
virtual
void
close
();
/**
* \par Description
* Handles key events (if forwarded to this Viewer instance).
*
* \param key the key code.
...
...
@@ -119,7 +111,6 @@ public:
virtual
void
keyEvent
(
KeyEvents
eventType
,
int
key
);
/**
* \par Description
* Handles mouse events forwarded from widget.
*
* \param eventType the event type.
...
...
@@ -132,7 +123,6 @@ public:
protected:
/**
* \par Description
* Creates a new OpenGL context in the calling thread. Needs to be called before any other OpenGL operation.
*
* \param x X coordinate of widget where to create the context.
...
...
@@ -143,20 +133,17 @@ protected:
void
createContext
(
int
x
,
int
y
,
int
width
,
int
height
);
/**
* \par Description
* OpenSceneGraph render window.
*/
boost
::
shared_ptr
<
osgViewer
::
GraphicsWindow
>
m_GraphicsWindow
;
/**
* \par Description
* OpenSceneGraph render context. This is required to be a "normal" pointer since using shared_ptr causes
* the code not to work (unknown reason for now). But since we do not offer a getter for it -> no prob.
*/
osg
::
GraphicsContext
*
m_GraphicsContext
;
/**
* \par Description
* Widget window data.
*/
boost
::
shared_ptr
<
WindowData
>
m_WindowData
;
...
...
src/graphicsEngine/WGEScene.h
View file @
224f430a
...
...
@@ -35,13 +35,11 @@ class WGEScene: public osg::Group
public:
/**
* \par Description
* Default constructor.
*/
WGEScene
();
/**
* \par Description
* Destructor.
*/
virtual
~
WGEScene
();
...
...
src/graphicsEngine/WGEViewer.h
View file @
224f430a
...
...
@@ -51,7 +51,6 @@ class WGEViewer: public WGEGraphicsWindow
public:
/**
* \par Description
* Default constructor.
*
* \param wdata the WindowData instance for the widget to use as render widget
...
...
@@ -64,19 +63,16 @@ public:
WGEViewer
(
boost
::
shared_ptr
<
WindowData
>
wdata
,
int
x
,
int
y
,
int
width
,
int
height
);
/**
* \par Description
* Destructor.
*/
virtual
~
WGEViewer
();
/**
* \par Description
* Paints this view to the window specified in constructor.
*/
void
paint
();
/**
* \par Description
* Updates size information. Also updates camera.
*
* \param width new width.
...
...
@@ -85,7 +81,6 @@ public:
virtual
void
resize
(
int
width
,
int
height
);
/**
* \par Description
* Getter for OpenSceneGraph Viewer instance.
*
* \return the OSG Viewer instance.
...
...
@@ -93,7 +88,6 @@ public:
boost
::
shared_ptr
<
osgViewer
::
CompositeViewer
>
getViewer
();
/**
* \par Description
* Sets the camera manipulator to use.
*
* \param manipulator the manipulator to use.
...
...
@@ -101,7 +95,6 @@ public:
void
setCameraManipulator
(
osgGA
::
MatrixManipulator
*
manipulator
);
/**
* \par Description
* Returns current active camera manipulator
*
* \return the active camera manipulator.
...
...
@@ -109,7 +102,6 @@ public:
osgGA
::
MatrixManipulator
*
getCameraManipulator
();
/**
* \par Description
* Sets the current camera.
*
* \param camera the OSG camera instance.
...
...
@@ -117,7 +109,6 @@ public:
void
setCamera
(
osg
::
Camera
*
camera
);
/**
* \par Description
* Returns the camera currently in use.
*
* \return the camera currently in use.
...
...
@@ -125,7 +116,6 @@ public:
osg
::
Camera
*
getCamera
();
/**
* \par Description
* Sets the scene graph node to be used for rendering.
*
* \param node part of the scene graph
...
...
@@ -133,7 +123,6 @@ public:
void
setScene
(
osg
::
Node
*
node
);
/**
* \par Description
* Returns the currently set OSG node.
*
* \return the node.
...
...
@@ -143,13 +132,11 @@ public:
protected:
/**
* \par Description
* OpenSceneGraph viewer.
*/
boost
::
shared_ptr
<
osgViewer
::
CompositeViewer
>
m_Viewer
;
/**
* \par Description
* The OpenSceneGraph view used in this (Composite)Viewer.
*/
boost
::
shared_ptr
<
osgViewer
::
View
>
m_View
;
...
...
src/graphicsEngine/WGraphicsEngine.h
View file @
224f430a
...
...
@@ -44,26 +44,22 @@ class WGraphicsEngine: public WThreadedRunner
public:
/**
* \par Description
* Default constructor.
*/
WGraphicsEngine
();
/**
* \par Description
* Destructor.
*/
virtual
~
WGraphicsEngine
();
/**
* \par Description
* Copy constructor
* \param other Reference on object to copy.
*/
WGraphicsEngine
(
const
WGraphicsEngine
&
other
);
/**
* \par Description
* Returns the root node of the OSG.
*
* \return the root node.
...
...
@@ -73,13 +69,11 @@ public:
protected:
/**
* \par Description
* OpenSceneGraph root node.
*/
WGEScene
*
m_RootNode
;
/**
* \par Description
* Handler for repainting and event handling. Gets executed in separate thread.
*/
virtual
void
threadMain
();
...
...
src/graphicsEngine/exceptions/WGEException.h
View file @
224f430a
...
...
@@ -29,7 +29,6 @@
#include "../../common/WException.h"
/**
* \par Description:
* General purpose exception and therefore base class for all graphics engine related exceptions.
*/
class
WGEException
:
public
WException
...
...
@@ -37,14 +36,12 @@ class WGEException: public WException
public:
/**
* \par Description
* Default constructor.
* \param msg the exception message.
*/
explicit
WGEException
(
const
std
::
string
&
msg
=
"Graphics Engine Exception"
);
/**
* \par Description
* Destructor.
*/
virtual
~
WGEException
()
throw
();
...
...
src/graphicsEngine/exceptions/WGEInitFailed.h
View file @
224f430a
...
...
@@ -29,7 +29,6 @@
#include "WGEException.h"
/**
* \par Description:
* Exception thrown if initialization of the graphics engine fails.
*/
class
WGEInitFailed
:
public
WGEException
...
...
@@ -37,14 +36,12 @@ class WGEInitFailed: public WGEException
public:
/**
* \par Description
* Default constructor.
* \param msg the exception message.
*/
explicit
WGEInitFailed
(
const
std
::
string
&
msg
=
"Graphics Engine Initialization failed"
);
/**
* \par Description
* Destructor.
*/
virtual
~
WGEInitFailed
()
throw
();
...
...
src/gui/WGUI.h
View file @
224f430a
...
...
@@ -35,7 +35,6 @@ class WGUI: public WThreadedRunner
public:
/**
* \par Description
* Default destructor.
*/
virtual
~
WGUI
();
...
...
src/gui/qt4/WMainApplication.h
View file @
224f430a
...
...
@@ -35,13 +35,11 @@ class WMainApplication: public WThreadedRunner
public:
/**
* \par Description
* Default Constructor.
*/
WMainApplication
();
/**
* \par Description
* Default destructor.
*/
virtual
~
WMainApplication
();
...
...
@@ -49,7 +47,6 @@ public:
protected:
/**
* \par Description
* Execution loop.
*/
virtual
void
threadMain
();
...
...
src/gui/qt4/WQtGLWidget.h
View file @
224f430a
...
...
@@ -44,7 +44,6 @@ class WQtGLWidget: public QWidget
{
public:
/**
* \par Description
* Default constructor.
*
* \param parent Parent widget.
...
...
@@ -54,7 +53,6 @@ public:
explicit
WQtGLWidget
(
QWidget
*
parent
=
0
);
/**
* \par Description
* Destructor.
*/
virtual
~
WQtGLWidget
();
...
...
@@ -67,7 +65,6 @@ public:
/**
* \par Description
* List of currently possible camera manipulators.
*/
enum
CameraManipulators
...
...
@@ -76,7 +73,6 @@ public:
};
/**
* \par Description
* Sets the camera manipulator to use.
*
* \param manipulator the manipulator.
...
...
@@ -84,7 +80,6 @@ public:
void
setCameraManipulator
(
CameraManipulators
manipulator
);
/**
* \par Description
* Returns the actually set camera manipulator.
*
* \return the manipulator.
...
...
@@ -93,7 +88,6 @@ public:
protected:
/**
* \par Description
* The viewer to the scene.
*/
boost
::
shared_ptr
<
WGEViewer
>
m_Viewer
;
...
...
@@ -103,7 +97,6 @@ protected:
// with further problems downstream (i.e. not being able to throw the trackball
#ifndef WIN32
/**
* \par Description
* Event handler for double clicks.
*
* \param event the event description.
...
...
@@ -111,7 +104,6 @@ protected:
virtual
void
mouseDoubleClickEvent
(
QMouseEvent
*
event
);
/**
* \par Description
* Event handler for close events.
*
* \param event the event description.
...
...
@@ -119,13 +111,11 @@ protected:
virtual
void
closeEvent
(
QCloseEvent
*
event
);
/**
* \par Description
* Event handler for destroy events (called after close).
*/
virtual
void
destroyEvent
(
bool
destroyWindow
=
true
,
bool
destroySubWindows
=
true
);
/**
* \par Description
* Event handler for resize events.
*
* \param event the event description.
...
...
@@ -133,7 +123,6 @@ protected:
virtual
void
resizeEvent
(
QResizeEvent
*
event
);
/**
* \par Description
* Event handler for key press.
*
* \param event the event description.
...
...
@@ -141,7 +130,6 @@ protected:
virtual
void
keyPressEvent
(
QKeyEvent
*
event
);
/**
* \par Description
* Event handler for key release.
*
* \param event the event description.
...
...
@@ -149,7 +137,6 @@ protected:
virtual
void
keyReleaseEvent
(
QKeyEvent
*
event
);
/**
* \par Description
* Event handler for mouse button press.
*
* \param event the event description.
...
...
@@ -157,7 +144,6 @@ protected:
virtual
void
mousePressEvent
(
QMouseEvent
*
event
);
/**
* \par Description
* Event handler for mouse button release.
*
* \param event the event description.
...
...
@@ -165,7 +151,6 @@ protected:
virtual
void
mouseReleaseEvent
(
QMouseEvent
*
event
);
/**
* \par Description
* Event handler for mouse moves.
*
* \param event the event description.
...
...
@@ -174,7 +159,6 @@ protected:
#endif
/**
* \par Description
* QT Callback for handling repaints.
*
* \param event event descriptor.
...
...
@@ -182,7 +166,6 @@ protected: