Commit 4644229b authored by Jan Möbius's avatar Jan Möbius

Fixed a lot of doxygen warnings

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@14182 383ad7c9-94d9-4d36-a494-682f7c89f535
parent d2397783
...@@ -130,9 +130,9 @@ class BackupInterface { ...@@ -130,9 +130,9 @@ class BackupInterface {
* This function will be called if a plugin requests a backup. You can * This function will be called if a plugin requests a backup. You can
* also react on this event if you reimplement this function in your plugin. * also react on this event if you reimplement this function in your plugin.
* *
* @param _id Identifier of the object to create the backup * @param _objectid Identifier of the object to create the backup
* @param _name Name of the Backup, to show the user what can be recovered * @param _name Name of the Backup, to show the user what can be recovered
* @param _internalId Unique identifier of the backup. This number is generated by the core and returned by the original signal. * @param _type What has been updated (This can be used to restrict the backup to certain parts of the object)
*/ */
virtual void slotCreateBackup( int _objectid , QString _name , UpdateType _type = UPDATE_ALL) {}; virtual void slotCreateBackup( int _objectid , QString _name , UpdateType _type = UPDATE_ALL) {};
...@@ -141,9 +141,9 @@ class BackupInterface { ...@@ -141,9 +141,9 @@ class BackupInterface {
* This function will be called if a plugin requests a backup. You can * This function will be called if a plugin requests a backup. You can
* also react on this event if you reimplement this function in your plugin. * also react on this event if you reimplement this function in your plugin.
* *
* @param _id Identifier of the object to create the backup * @param _objectids Identifiers of the object to create the backup
* @param _name Name of the Backup, to show the user what can be recovered * @param _name Name of the Backup, to show the user what can be recovered
* @param _internalId Unique identifier of the backup. This number is generated by the core and returned by the original signal. * @param _types What has been updated (This can be used to restrict the backup to certain parts of the objects)
*/ */
virtual void slotCreateBackup( IdList _objectids , QString _name , std::vector<UpdateType> _types) {}; virtual void slotCreateBackup( IdList _objectids , QString _name , std::vector<UpdateType> _types) {};
...@@ -156,7 +156,7 @@ class BackupInterface { ...@@ -156,7 +156,7 @@ class BackupInterface {
* If you have any pointers or references to the given object you have to * If you have any pointers or references to the given object you have to
* clean them up here. * clean them up here.
* *
* @param _id Identifier of the object which is about to be restored * @param _objectid Identifier of the object which is about to be restored
*/ */
virtual void slotAboutToRestore( int _objectid ) {}; virtual void slotAboutToRestore( int _objectid ) {};
......
...@@ -138,7 +138,7 @@ private slots: ...@@ -138,7 +138,7 @@ private slots:
* This slot will be called indicating that a scenegraph node not belonging to an object * This slot will be called indicating that a scenegraph node not belonging to an object
* has been picked. * has been picked.
* *
* @param _node id of the picked node * @param _nodeId id of the picked node
*/ */
virtual void slotUpdateContextMenuNode( int _nodeId ) {}; virtual void slotUpdateContextMenuNode( int _nodeId ) {};
......
...@@ -86,7 +86,7 @@ class INIInterface { ...@@ -86,7 +86,7 @@ class INIInterface {
* @param _ini ini file * @param _ini ini file
* @param _id Id of the object to load data for * @param _id Id of the object to load data for
*/ */
virtual void loadIniFile( INIFile& /*_ini*/ ,int /*_id*/ ) {}; virtual void loadIniFile( INIFile& _ini ,int _id ) {};
/** \brief Save per object settings /** \brief Save per object settings
* *
...@@ -97,7 +97,7 @@ class INIInterface { ...@@ -97,7 +97,7 @@ class INIInterface {
* @param _ini ini file * @param _ini ini file
* @param _id Identifier of the object to save * @param _id Identifier of the object to save
*/ */
virtual void saveIniFile( INIFile& /*_ini*/ ,int /*_id*/) {}; virtual void saveIniFile( INIFile& _ini ,int _id) {};
/** @} */ /** @} */
...@@ -119,7 +119,7 @@ class INIInterface { ...@@ -119,7 +119,7 @@ class INIInterface {
* *
* @param _ini ini file * @param _ini ini file
*/ */
virtual void loadIniFileOptions( INIFile& /*_ini*/ ) {}; virtual void loadIniFileOptions( INIFile& _ini ) {};
/** \brief Load per Plugin settings after objects are loaded /** \brief Load per Plugin settings after objects are loaded
* *
...@@ -130,7 +130,7 @@ class INIInterface { ...@@ -130,7 +130,7 @@ class INIInterface {
* *
* @param _ini ini file * @param _ini ini file
*/ */
virtual void loadIniFileOptionsLast( INIFile& /*_ini*/ ) {}; virtual void loadIniFileOptionsLast( INIFile& _ini ) {};
/** \brief Save Plugin Options /** \brief Save Plugin Options
* When the core is about to save an ini file this slot will be * When the core is about to save an ini file this slot will be
...@@ -140,7 +140,7 @@ class INIInterface { ...@@ -140,7 +140,7 @@ class INIInterface {
* *
* @param _ini ini file * @param _ini ini file
*/ */
virtual void saveIniFileOptions( INIFile& /*_ini*/ ) {}; virtual void saveIniFileOptions( INIFile& _ini ) {};
/** \brief Save per Plugin settings when application is about to quit /** \brief Save per Plugin settings when application is about to quit
* *
...@@ -149,7 +149,7 @@ class INIInterface { ...@@ -149,7 +149,7 @@ class INIInterface {
* *
* @param _ini ini file * @param _ini ini file
*/ */
virtual void saveOnExit( INIFile& /*_ini*/ ) {}; virtual void saveOnExit( INIFile& _ini ) {};
/** @} */ /** @} */
......
...@@ -47,7 +47,7 @@ ...@@ -47,7 +47,7 @@
/** \file LoggingInterface.hh /** \file LoggingInterface.hh
* *
* Interface for sending log messages to the log widget.\ref * Interface for sending log messages to the log widget. \ref loggingInterfacePage
*/ */
/** \page loggingInterfacePage Logging Interface /** \page loggingInterfacePage Logging Interface
......
...@@ -686,6 +686,14 @@ BaseObject*& objectRoot(); ...@@ -686,6 +686,14 @@ BaseObject*& objectRoot();
* *
* @param defaultDir If the property doesn't exist yet, defaultDir is used * @param defaultDir If the property doesn't exist yet, defaultDir is used
* as the initial location. * as the initial location.
*
* @param parent Parent qt widget
* @param caption Caption of the dialog
* @param defaultDir Default directory when dialog is shown
* @param filter name filters
* @param selectedFilter currently selected filter
* @param options filedialog options
*
*/ */
DLLEXPORT DLLEXPORT
QString getOpenFileName(const QString &configProperty, QString getOpenFileName(const QString &configProperty,
...@@ -702,6 +710,13 @@ QString getOpenFileName(const QString &configProperty, ...@@ -702,6 +710,13 @@ QString getOpenFileName(const QString &configProperty,
* *
* @param defaultDir If the property doesn't exist yet, defaultDir is used * @param defaultDir If the property doesn't exist yet, defaultDir is used
* as the initial location. * as the initial location.
*
* @param parent Parent qt widget
* @param caption Caption of the dialog
* @param defaultDir Default directory when dialog is shown
* @param filter name filters
* @param selectedFilter currently selected filter
* @param options filedialog options
*/ */
DLLEXPORT DLLEXPORT
QString getSaveFileName(const QString &configProperty, QString getSaveFileName(const QString &configProperty,
......
...@@ -182,7 +182,6 @@ void setTrackBallCenter(const ACG::Vec3d& _center, int _viewer ); ...@@ -182,7 +182,6 @@ void setTrackBallCenter(const ACG::Vec3d& _center, int _viewer );
* *
* The scene is rotated around the trackball center when using the mouse * The scene is rotated around the trackball center when using the mouse
* *
* @param _center Center of the trackball
* @param _viewer Id of the viewer to use. * @param _viewer Id of the viewer to use.
* ALL_VIEWERS will set all viewers (Default) * ALL_VIEWERS will set all viewers (Default)
* ACTIVE_VIEWER active viewer * ACTIVE_VIEWER active viewer
...@@ -199,6 +198,7 @@ const ACG::Vec3d trackBallCenter( int _viewer ); ...@@ -199,6 +198,7 @@ const ACG::Vec3d trackBallCenter( int _viewer );
* ALL_VIEWERS will set all viewers (Default) * ALL_VIEWERS will set all viewers (Default)
* ACTIVE_VIEWER active viewer * ACTIVE_VIEWER active viewer
* 0..3 Choose viewer explicitly * 0..3 Choose viewer explicitly
* @param _center Center of the current scene
*/ */
DLLEXPORT DLLEXPORT
void setScenePos(const ACG::Vec3d& _center , int _viewer = ALL_VIEWERS); void setScenePos(const ACG::Vec3d& _center , int _viewer = ALL_VIEWERS);
...@@ -344,6 +344,8 @@ void perspectiveProjection( int _viewer = ALL_VIEWERS ); ...@@ -344,6 +344,8 @@ void perspectiveProjection( int _viewer = ALL_VIEWERS );
* @param _viewer Id of the viewer to use. * @param _viewer Id of the viewer to use.
* ACTIVE_VIEWER active viewer * ACTIVE_VIEWER active viewer
* 0..3 Choose viewer explicitly * 0..3 Choose viewer explicitly
*
* @param _mode New drawmode of the given viewer
*/ */
DLLEXPORT DLLEXPORT
void setDrawMode( const ACG::SceneGraph::DrawModes::DrawMode _mode , int _viewer = ALL_VIEWERS); void setDrawMode( const ACG::SceneGraph::DrawModes::DrawMode _mode , int _viewer = ALL_VIEWERS);
......
...@@ -76,8 +76,7 @@ class PostProcessorInterface { ...@@ -76,8 +76,7 @@ class PostProcessorInterface {
/** \brief announce name for the postProcessor function /** \brief announce name for the postProcessor function
* *
* * @return The name of the post processor
* @param _name displayed name of the postProcessor function
*/ */
virtual QString postProcessorName() = 0; virtual QString postProcessorName() = 0;
......
...@@ -110,7 +110,7 @@ class ProcessInterface { ...@@ -110,7 +110,7 @@ class ProcessInterface {
* @param _jobId String which is used as the id of the thread * @param _jobId String which is used as the id of the thread
* @param _text The text of the job's description * @param _text The text of the job's description
*/ */
virtual void setJobDescription(QString /*_jobId*/, QString /*_text*/ ) {}; virtual void setJobDescription(QString _jobId, QString _text ) {};
/** \brief Cancel your job /** \brief Cancel your job
* *
...@@ -128,12 +128,13 @@ class ProcessInterface { ...@@ -128,12 +128,13 @@ class ProcessInterface {
virtual void finishJob(QString _jobId ) {}; virtual void finishJob(QString _jobId ) {};
private slots : private slots :
/** \brief A job has been canceled /** \brief A job has been canceled
* *
* This function is called when the user cancels a job. * This function is called when the user cancels a job.
* The returned name is the name of the job which has been canceled * The returned name is the name of the job which has been canceled
* *
* @param _jobId String which is used as the id of the thread * @param _job String which is used as the id of the thread
*/ */
virtual void canceledJob (QString _job ) {}; virtual void canceledJob (QString _job ) {};
......
...@@ -246,7 +246,7 @@ class TextureInterface { ...@@ -246,7 +246,7 @@ class TextureInterface {
* *
* @param _id Id of the object where the current texture should be fetched from * @param _id Id of the object where the current texture should be fetched from
* @param _multiTextureName name of a multi texture * @param _multiTextureName name of a multi texture
* @param _textureName this returns the names of all sub textures that are combined under the given multi texture * @param _subTextures this returns the names of all sub textures that are combined under the given multi texture
*/ */
virtual void getSubTextures( int _id, QString _multiTextureName, QStringList& _subTextures ) {}; virtual void getSubTextures( int _id, QString _multiTextureName, QStringList& _subTextures ) {};
...@@ -324,9 +324,13 @@ class TextureInterface { ...@@ -324,9 +324,13 @@ class TextureInterface {
/** \brief A multiTexture has been added by a plugin. /** \brief A multiTexture has been added by a plugin.
* *
* This slot is called when a Multi Texture has been added by a plugin. * This slot is called when a multi Texture has been added by a plugin.
* *
* @param _name Name of the Added texture (has to be equal to the property name) * A multi texture has a global name which is defined as the texture group and consists of
* mutliple sub textures which have their own names but are all used when the group is active.
*
* @param _textureGroup Name of the texture group that is associated with the texture.
* @param _name Name of the Added texture (has to be equal to the property name)
* @param _filename Filename of the Texture Image to be used * @param _filename Filename of the Texture Image to be used
* @param _id Id of the object which should use the texture * @param _id Id of the object which should use the texture
* @param _textureId The new id of the texture( This id is object related!!) * @param _textureId The new id of the texture( This id is object related!!)
...@@ -436,7 +440,7 @@ class TextureInterface { ...@@ -436,7 +440,7 @@ class TextureInterface {
* *
* @param _id Id of the object where the current texture should be fetched from * @param _id Id of the object where the current texture should be fetched from
* @param _multiTextureName name of a multi texture * @param _multiTextureName name of a multi texture
* @param _textureName this returns the names of all sub textures that are combined under the given multi texture * @param _subTextures this returns the names of all sub textures that are combined under the given multi texture
*/ */
virtual void slotGetSubTextures( int _id, QString _multiTextureName, QStringList& _subTextures ) {}; virtual void slotGetSubTextures( int _id, QString _multiTextureName, QStringList& _subTextures ) {};
......
...@@ -59,20 +59,20 @@ class ViewInterface { ...@@ -59,20 +59,20 @@ class ViewInterface {
* @param _name Name of the Widget * @param _name Name of the Widget
* @param _widget The requested widget or 0 if not found * @param _widget The requested widget or 0 if not found
*/ */
virtual void getStackWidget( QString /*_name*/, QWidget*& /*_widget*/ ) {}; virtual void getStackWidget( QString _name, QWidget*& _widget ) {};
/** Update a widget form the Stackwidget with Name. * /** Update a widget form the Stackwidget with Name. *
* @param _name Name of the Widget * @param _name Name of the Widget
* @param _widget The requested widget or 0 if not found * @param _widget The requested widget or 0 if not found
*/ */
virtual void updateStackWidget( QString /*_name*/, QWidget* /*_widget*/ ) {}; virtual void updateStackWidget( QString _name, QWidget* _widget ) {};
/** Add a widget to the Stackwidget with a Name. /** Add a widget to the Stackwidget with a Name.
* *
* @param _name Name of the Widget * @param _name Name of the Widget
* @param _widget The new widget * @param _widget The new widget
*/ */
virtual void addStackWidget( QString /*_name*/, QWidget* /*_widget*/ ) {}; virtual void addStackWidget( QString _name, QWidget* _widget ) {};
public : public :
......
...@@ -87,8 +87,8 @@ class ViewModeInterface { ...@@ -87,8 +87,8 @@ class ViewModeInterface {
* With this function you can define a set of toolbars which should be visible * With this function you can define a set of toolbars which should be visible
* for the specified view mode. * for the specified view mode.
* *
* @param _mode Name of the ViewMode * @param _mode Name of the ViewMode
* @param _usedWidgets List of used toolbars * @param _usedToolbars List of used toolbars
*/ */
virtual void defineViewModeToolbars(QString _mode, QStringList _usedToolbars){}; virtual void defineViewModeToolbars(QString _mode, QStringList _usedToolbars){};
...@@ -97,8 +97,8 @@ class ViewModeInterface { ...@@ -97,8 +97,8 @@ class ViewModeInterface {
* With this function you can define a set of context menus which should be visible * With this function you can define a set of context menus which should be visible
* for the specified view mode. * for the specified view mode.
* *
* @param _mode Name of the ViewMode * @param _mode Name of the ViewMode
* @param _usedWidgets List of used context menus * @param _usedContextMenus List of used context menus
*/ */
virtual void defineViewModeContextMenus(QString _mode, QStringList _usedContextMenus){}; virtual void defineViewModeContextMenus(QString _mode, QStringList _usedContextMenus){};
......
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