diff --git a/BasePlugin/BackupInterface.hh b/BasePlugin/BackupInterface.hh index 0292688f6f441159b6ef026b6c7658278dffeae9..d2d444208341b231ab3fe1d58771c64406954c56 100644 --- a/BasePlugin/BackupInterface.hh +++ b/BasePlugin/BackupInterface.hh @@ -130,9 +130,9 @@ class BackupInterface { * 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. * - * @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 _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) {}; @@ -141,9 +141,9 @@ class BackupInterface { * 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. * - * @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 _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 _types) {}; @@ -156,7 +156,7 @@ class BackupInterface { * If you have any pointers or references to the given object you have to * 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 ) {}; diff --git a/BasePlugin/ContextMenuInterface.hh b/BasePlugin/ContextMenuInterface.hh index 37826906133504668e78bf481a43266ef052b3d8..6080b683600577f2cf9b7dd56a57c8e89cae8a6f 100644 --- a/BasePlugin/ContextMenuInterface.hh +++ b/BasePlugin/ContextMenuInterface.hh @@ -138,7 +138,7 @@ private slots: * This slot will be called indicating that a scenegraph node not belonging to an object * has been picked. * - * @param _node id of the picked node + * @param _nodeId id of the picked node */ virtual void slotUpdateContextMenuNode( int _nodeId ) {}; diff --git a/BasePlugin/INIInterface.hh b/BasePlugin/INIInterface.hh index bc13b1cb5627a4fe9b68ba6d338f9af02b1551fb..4138b44731f87154d2bfaf74be5d5afbe60e5973 100644 --- a/BasePlugin/INIInterface.hh +++ b/BasePlugin/INIInterface.hh @@ -86,7 +86,7 @@ class INIInterface { * @param _ini ini file * @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 * @@ -97,7 +97,7 @@ class INIInterface { * @param _ini ini file * @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 { * * @param _ini ini file */ - virtual void loadIniFileOptions( INIFile& /*_ini*/ ) {}; + virtual void loadIniFileOptions( INIFile& _ini ) {}; /** \brief Load per Plugin settings after objects are loaded * @@ -130,7 +130,7 @@ class INIInterface { * * @param _ini ini file */ - virtual void loadIniFileOptionsLast( INIFile& /*_ini*/ ) {}; + virtual void loadIniFileOptionsLast( INIFile& _ini ) {}; /** \brief Save Plugin Options * When the core is about to save an ini file this slot will be @@ -140,7 +140,7 @@ class INIInterface { * * @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 * @@ -149,7 +149,7 @@ class INIInterface { * * @param _ini ini file */ - virtual void saveOnExit( INIFile& /*_ini*/ ) {}; + virtual void saveOnExit( INIFile& _ini ) {}; /** @} */ diff --git a/BasePlugin/LoggingInterface.hh b/BasePlugin/LoggingInterface.hh index d2fc3f3107a8d3eebb64a15e8aad5e03037c7ad1..746eb0540394f6f333ec8e635fbe89d70c66f542 100644 --- a/BasePlugin/LoggingInterface.hh +++ b/BasePlugin/LoggingInterface.hh @@ -47,7 +47,7 @@ /** \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 diff --git a/BasePlugin/PluginFunctions.hh b/BasePlugin/PluginFunctions.hh index 58a93641efcac79acc1b576a5d99f4cb43677b98..1c0819ba11a3556e03b2c39624820571836442d4 100644 --- a/BasePlugin/PluginFunctions.hh +++ b/BasePlugin/PluginFunctions.hh @@ -686,6 +686,14 @@ BaseObject*& objectRoot(); * * @param defaultDir If the property doesn't exist yet, defaultDir is used * 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 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 * 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 QString getSaveFileName(const QString &configProperty, diff --git a/BasePlugin/PluginFunctionsViewControls.hh b/BasePlugin/PluginFunctionsViewControls.hh index 8615e30347161d241a7d64cafbd1b7f766f49a6e..d8bed7ffd00fa37b92b1ca4efab99050d23c5ddc 100644 --- a/BasePlugin/PluginFunctionsViewControls.hh +++ b/BasePlugin/PluginFunctionsViewControls.hh @@ -182,7 +182,6 @@ void setTrackBallCenter(const ACG::Vec3d& _center, int _viewer ); * * 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. * ALL_VIEWERS will set all viewers (Default) * ACTIVE_VIEWER active viewer @@ -199,6 +198,7 @@ const ACG::Vec3d trackBallCenter( int _viewer ); * ALL_VIEWERS will set all viewers (Default) * ACTIVE_VIEWER active viewer * 0..3 Choose viewer explicitly + * @param _center Center of the current scene */ DLLEXPORT void setScenePos(const ACG::Vec3d& _center , int _viewer = ALL_VIEWERS); @@ -344,6 +344,8 @@ void perspectiveProjection( int _viewer = ALL_VIEWERS ); * @param _viewer Id of the viewer to use. * ACTIVE_VIEWER active viewer * 0..3 Choose viewer explicitly + * + * @param _mode New drawmode of the given viewer */ DLLEXPORT void setDrawMode( const ACG::SceneGraph::DrawModes::DrawMode _mode , int _viewer = ALL_VIEWERS); diff --git a/BasePlugin/PostProcessorInterface.hh b/BasePlugin/PostProcessorInterface.hh index a20a41df499345529ddd61804c7f63b32971864e..22b39bff33cd346e0efb9e437027be7ea5f52625 100644 --- a/BasePlugin/PostProcessorInterface.hh +++ b/BasePlugin/PostProcessorInterface.hh @@ -76,8 +76,7 @@ class PostProcessorInterface { /** \brief announce name for the postProcessor function * - * - * @param _name displayed name of the postProcessor function + * @return The name of the post processor */ virtual QString postProcessorName() = 0; diff --git a/BasePlugin/ProcessInterface.hh b/BasePlugin/ProcessInterface.hh index 912f28d8e8338a3837e29b9d2b1e4aa8475e45ac..179d2e4a846ccca80a945d5f72aba9ef3c102333 100644 --- a/BasePlugin/ProcessInterface.hh +++ b/BasePlugin/ProcessInterface.hh @@ -110,7 +110,7 @@ class ProcessInterface { * @param _jobId String which is used as the id of the thread * @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 * @@ -128,12 +128,13 @@ class ProcessInterface { virtual void finishJob(QString _jobId ) {}; private slots : + /** \brief A job has been canceled * * This function is called when the user cancels a job. * 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 ) {}; diff --git a/BasePlugin/TextureInterface.hh b/BasePlugin/TextureInterface.hh index 0084c4b7114548b35d1471ecae193389be0ad54b..2f960378621e59cc6ab2a4c0ad6377746db7eb5d 100644 --- a/BasePlugin/TextureInterface.hh +++ b/BasePlugin/TextureInterface.hh @@ -246,7 +246,7 @@ class TextureInterface { * * @param _id Id of the object where the current texture should be fetched from * @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 ) {}; @@ -324,9 +324,13 @@ class TextureInterface { /** \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 _id Id of the object which should use the texture * @param _textureId The new id of the texture( This id is object related!!) @@ -436,7 +440,7 @@ class TextureInterface { * * @param _id Id of the object where the current texture should be fetched from * @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 ) {}; diff --git a/BasePlugin/ViewInterface.hh b/BasePlugin/ViewInterface.hh index 5c3d2669276b2133d99a8dc0f318de17f0cf978b..bba6845f8f8b170ac8a2a8c4afacc12aafba4fb3 100644 --- a/BasePlugin/ViewInterface.hh +++ b/BasePlugin/ViewInterface.hh @@ -59,20 +59,20 @@ class ViewInterface { * @param _name Name of the Widget * @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. * * @param _name Name of the Widget * @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. * * @param _name Name of the Widget * @param _widget The new widget */ - virtual void addStackWidget( QString /*_name*/, QWidget* /*_widget*/ ) {}; + virtual void addStackWidget( QString _name, QWidget* _widget ) {}; public : diff --git a/BasePlugin/ViewModeInterface.hh b/BasePlugin/ViewModeInterface.hh index 66cf1c80dfdae92f6d4a83cdc3d6310030020fc5..e56ff79b4adc350f4135b8667755dc6b52fe5c3c 100644 --- a/BasePlugin/ViewModeInterface.hh +++ b/BasePlugin/ViewModeInterface.hh @@ -87,8 +87,8 @@ class ViewModeInterface { * With this function you can define a set of toolbars which should be visible * for the specified view mode. * - * @param _mode Name of the ViewMode - * @param _usedWidgets List of used toolbars + * @param _mode Name of the ViewMode + * @param _usedToolbars List of used toolbars */ virtual void defineViewModeToolbars(QString _mode, QStringList _usedToolbars){}; @@ -97,8 +97,8 @@ class ViewModeInterface { * With this function you can define a set of context menus which should be visible * for the specified view mode. * - * @param _mode Name of the ViewMode - * @param _usedWidgets List of used context menus + * @param _mode Name of the ViewMode + * @param _usedContextMenus List of used context menus */ virtual void defineViewModeContextMenus(QString _mode, QStringList _usedContextMenus){};