Commit 33af5a5c authored by Jan Möbius's avatar Jan Möbius

Minor Documentation updates

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@13749 383ad7c9-94d9-4d36-a494-682f7c89f535
parent bea4a36d
......@@ -330,7 +330,11 @@ namespace DrawModes {
The id of the new draw mode is returned. If it already exists, the id of the existing one
is returned.
@param _name Name of the drawmode to add
Property based draw modes consist of various flags, which define which primitives and
additional information are send to the gpu.
@param _name Name of the draw mode to add
@param _propertyBased If set to true a property based draw mode is created.
@return Id of the new draw mode
*/
ACGDLLEXPORT
......
......@@ -53,7 +53,7 @@
#define MESHSELECTION_HH
/*! \file MeshSelection.hh
/*! \file MeshSelectionT.hh
\brief Functions for selection on a mesh
*/
......
......@@ -70,9 +70,10 @@ namespace SceneGraph {
//== CLASS DEFINITION =========================================================
/** \class CoordinateSystemNode Node for displaying coordinate systems
/** \class CoordinateSystemNode
* \brief Node for displaying coordinate systems
CoordinateSystemNode renders a coordinate system.
CoordinateSystemNode renders a coordinate system.
**/
......
......@@ -54,8 +54,6 @@
//=============================================================== INCLUDES ====
#include <iostream>
#include <QObject>
//======================================================= CLASS DEFINITION ====
......@@ -65,7 +63,8 @@
*/
/** A wrapper class, getting events from an plugin, prepending plugin name to the scripting
/** \class ScriptingWrapper
* A wrapper class, getting events from an plugin, prepending plugin name to the scripting
* and passing it to the core. This class is generated for every plugin of the core.
*/
class ScriptingWrapper : public QObject {
......@@ -73,19 +72,26 @@ class ScriptingWrapper : public QObject {
Q_OBJECT
signals:
/// complete signalfor scripting plugins
/// complete signal for scripting plugins
void scriptInfo( QString _pluginName , QString _functionName );
public:
/// Standard Constructor
/** \brief Standard Constructor
*
* @param _pluginName Name of the Plugin which uses this logger (Prepended to all Output)
*/
ScriptingWrapper(QString _pluginName);
/// Destructor
~ScriptingWrapper();
private slots:
/// prepend pluginname and emit extended signal
/** \brief This function prepends the plugin name and emits the extended signal to the core.
*
* @param _functionName Name of the function
*/
void slotScriptInfo( QString _functionName );
private:
......
......@@ -59,7 +59,6 @@
/**
* @param _pluginName Name of the Plugin which uses this logger (Prepended to all Output)
* @param _type Default log type ( used for streaming operations )
*/
ScriptingWrapper::ScriptingWrapper(QString _pluginName ) :
pluginName_(_pluginName)
......
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