From 43595019f07f4bb0de06f4f56459e47db2b27568 Mon Sep 17 00:00:00 2001 From: jfa Date: Fri, 16 Jul 2021 22:58:18 +0300 Subject: [PATCH] Fight with dev_docs doxygen warnings --- doc/salome/tui/doxyfile.in | 20 ++++------- src/CAM/CAM_Application.cxx | 11 +++--- src/CAM/CAM_DataModel.cxx | 17 ++++++---- src/CAM/CAM_DataObject.cxx | 3 +- src/CAM/CAM_Module.cxx | 10 +++--- src/CASCatch/CASCatch_Failure.cxx | 4 +-- src/DDS/DDS_DicGroup.cxx | 4 +-- src/GLViewer/GLViewer_AspectLine.cxx | 34 +++++++++---------- src/GLViewer/GLViewer_AspectLine.h | 2 +- src/GLViewer/GLViewer_BaseObjects.cxx | 26 +++++++------- src/GLViewer/GLViewer_Context.cxx | 16 ++++----- src/GLViewer/GLViewer_Context.h | 8 ++--- src/GLViewer/GLViewer_Drawer.cxx | 3 +- src/GLViewer/GLViewer_Drawer.h | 24 ++++++------- src/GLViewer/GLViewer_Geom.cxx | 14 ++++---- src/GLViewer/GLViewer_Grid.cxx | 2 +- src/GLViewer/GLViewer_Group.cxx | 2 +- src/GLViewer/GLViewer_Tools.cxx | 2 +- src/GLViewer/GLViewer_ViewPort2d.h | 8 ++--- src/OBJECT/SALOME_InteractiveObject.cxx | 2 +- src/OCCViewer/OCCViewer_AxialScaleDlg.cxx | 14 ++++---- src/Qtx/QtxListBox.cxx | 22 ++++++------ src/Qtx/QtxMsgHandler.cxx | 2 +- src/Qtx/QtxPathListEdit.cxx | 8 ++--- src/Qtx/QtxTreeView.cxx | 8 ++--- src/Qtx/QtxWorkstack.cxx | 4 +-- src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx | 6 ++-- src/SUIT/SUIT_Accel.h | 2 +- src/SUIT/SUIT_Application.h | 2 +- src/SUIT/SUIT_DataBrowser.cxx | 2 +- src/SUIT/SUIT_DataObject.cxx | 1 - src/SUIT/SUIT_MessageBox.cxx | 16 ++++----- src/SUIT/SUIT_MessageBox.h | 8 ++--- src/SUIT/SUIT_TreeSync.h | 4 +-- src/SUIT/SUIT_ViewManager.cxx | 2 +- src/SVTK/SVTK_AreaPicker.h | 2 +- src/SVTK/SVTK_InteractorStyle.cxx | 2 +- src/SVTK/SVTK_ViewModel.h | 8 ++--- src/SVTK/SVTK_ViewWindow.h | 2 +- src/SalomeApp/Test/TestSalomeApp.cxx | 3 +- src/TOOLSGUI/ToolsGUI.cxx | 4 +-- src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.cxx | 4 +-- src/VTKViewer/VTKViewer_Algorithm.h | 4 +-- src/VTKViewer/VTKViewer_AppendFilter.h | 4 +-- src/VTKViewer/VTKViewer_Filter.cxx | 2 +- src/VTKViewer/VTKViewer_GeometryFilter.h | 5 ++- src/VTKViewer/VTKViewer_InteractorStyle.cxx | 2 +- src/VTKViewer/VTKViewer_MarkerDlg.cxx | 2 +- src/VTKViewer/VTKViewer_MarkerWidget.cxx | 2 +- src/VTKViewer/VTKViewer_Trihedron.h | 2 +- 50 files changed, 177 insertions(+), 184 deletions(-) diff --git a/doc/salome/tui/doxyfile.in b/doc/salome/tui/doxyfile.in index 36875dc9f..b12436830 100644 --- a/doc/salome/tui/doxyfile.in +++ b/doc/salome/tui/doxyfile.in @@ -6,7 +6,6 @@ PROJECT_NUMBER = OUTPUT_DIRECTORY = GUI CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English -USE_WINDOWS_ENCODING = NO BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ABBREVIATE_BRIEF = @@ -18,7 +17,6 @@ STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES MULTILINE_CPP_IS_BRIEF = NO -DETAILS_AT_TOP = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 5 @@ -56,7 +54,6 @@ GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 25 SHOW_USED_FILES = YES -SHOW_DIRECTORIES = NO FILE_VERSION_FILTER = #--------------------------------------------------------------------------- @@ -64,7 +61,7 @@ FILE_VERSION_FILTER = #--------------------------------------------------------------------------- QUIET = NO WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text" @@ -119,7 +116,6 @@ HTML_HEADER = @CMAKE_CURRENT_BINARY_DIR@/static/header.html HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css HTML_EXTRA_FILES = @CMAKE_CURRENT_SOURCE_DIR@/images/head.png -HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO CHM_FILE = HHC_LOCATION = @@ -170,8 +166,6 @@ MAN_LINKS = NO #--------------------------------------------------------------------------- GENERATE_XML = NO XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- @@ -188,7 +182,7 @@ PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES @@ -196,12 +190,12 @@ EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -PREDEFINED = +PREDEFINED = Standard_EXPORT Handle(a):=Handle DEFINE_STANDARD_RTTIEXT DEFINE_STANDARD_HANDLE IMPLEMENT_STANDARD_RTTIEXT vtkStandardNewMacro vtkTypeMacro vtkCxxSetObjectMacro vtkNotUsed(a):=a Q_ENUM _PTR(a):=_PTR EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = NO #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- TAGFILES = GENERATE_TAGFILE = @@ -210,7 +204,7 @@ EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- CLASS_DIAGRAMS = YES HIDE_UNDOC_RELATIONS = NO @@ -229,8 +223,6 @@ DOT_IMAGE_FORMAT = png DOT_FONTNAME = Arial DOT_PATH = DOTFILE_DIRS = -MAX_DOT_GRAPH_WIDTH = 1024 -MAX_DOT_GRAPH_HEIGHT = 1200 MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO @@ -238,6 +230,6 @@ GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- SEARCHENGINE = YES diff --git a/src/CAM/CAM_Application.cxx b/src/CAM/CAM_Application.cxx index b4b4d9aa8..7c6b45040 100644 --- a/src/CAM/CAM_Application.cxx +++ b/src/CAM/CAM_Application.cxx @@ -174,7 +174,7 @@ CAM_Application::ModuleList CAM_Application::modules() const /*! \brief Get all loaded modules. - \param returning list of modules + \param out being returned list of modules */ void CAM_Application::modules( CAM_Application::ModuleList& out ) const { @@ -291,6 +291,7 @@ void CAM_Application::loadModules() - module library can not be loaded by some reason \param modName module name + \param showMsg If true, show occured errors (if any) in a warning dialog \return module object pointer or 0 if module could not be loaded */ CAM_Module* CAM_Application::loadModule( const QString& modName, const bool showMsg ) @@ -586,8 +587,8 @@ void CAM_Application::setActiveStudy( SUIT_Study* study ) \brief Check module availability. The method can be redefined in successors. Default implementation returns \c true. + Input parameter is the module title - \param title module title \return \c true if module is accessible; \c false otherwise */ bool CAM_Application::checkModule( const QString& ) @@ -601,7 +602,7 @@ bool CAM_Application::checkModule( const QString& ) This virtual method can be re-implemented in the successors. Base implementation does nothing. - \param mod module being added + The inpit parameter is the module being added */ void CAM_Application::moduleAdded( CAM_Module* /*mod*/ ) { @@ -672,8 +673,8 @@ QString CAM_Application::moduleDescription( const QString& name ) } /*! - \brief Get module library name by its title (user name). - \param title module name or title + \brief Get module library name by its name or title (user name). + \param name module name or title \param full if \c true, return full library name, otherwise return its internal name \return module library name or null QString if module is not found */ diff --git a/src/CAM/CAM_DataModel.cxx b/src/CAM/CAM_DataModel.cxx index bbe87c497..7b82ec13b 100644 --- a/src/CAM/CAM_DataModel.cxx +++ b/src/CAM/CAM_DataModel.cxx @@ -134,9 +134,10 @@ void CAM_DataModel::onDestroyed( SUIT_DataObject* obj ) This method should be re-implemented in the successor classes. Default implementation returns \c true. - \param name study name - \param study study - \param files list of file names from which data should be loaded + The first parameter is the study name + The second parameter is the study + The third parameter is a list of file names from which data should be loaded + \return \c true if data model is loaded successfully */ bool CAM_DataModel::open( const QString& /*name*/, @@ -152,7 +153,8 @@ bool CAM_DataModel::open( const QString& /*name*/, This method should be re-implemented in the successor classes. Default implementation returns \c true. - \param files list of file names to which data should be saved + The input parameter is a list of file names to which data should be saved + \return \c true if data model is saved successfully */ bool CAM_DataModel::save( QStringList& ) @@ -166,9 +168,10 @@ bool CAM_DataModel::save( QStringList& ) This method should be re-implemented in the successor classes. Default implementation returns \c true. - \param name study name - \param study study - \param files resulting list of file names to which data is saved + The first parameter is the study name + The second parameter is the study + The third parameter is the resulting list of file names to which data is saved + \return \c true if data model is saved successfully */ bool CAM_DataModel::saveAs( const QString& /*name*/, diff --git a/src/CAM/CAM_DataObject.cxx b/src/CAM/CAM_DataObject.cxx index c7931e80b..2ebdc90cd 100644 --- a/src/CAM/CAM_DataObject.cxx +++ b/src/CAM/CAM_DataObject.cxx @@ -151,9 +151,8 @@ QPixmap CAM_ModuleObject::icon( const int id ) const /*! \brief Get data object tooltip for the specified column. - The parameter \a id specifies the column identificator + The parameter specifies the column identificator - \param id column id \return object tooltip for the specified column */ QString CAM_ModuleObject::toolTip( const int /*id*/ ) const diff --git a/src/CAM/CAM_Module.cxx b/src/CAM/CAM_Module.cxx index 13ae3c4ab..1fafa676d 100644 --- a/src/CAM/CAM_Module.cxx +++ b/src/CAM/CAM_Module.cxx @@ -293,8 +293,8 @@ void CAM_Module::studyClosed( SUIT_Study* study ) Default implementation does nothing. - \param oldStudy old study - \param newStudy new study + The first parameter is the old study + The second parameter is the new study */ void CAM_Module::studyChanged( SUIT_Study* /*oldStudy*/, SUIT_Study* /*newStudy*/ ) { @@ -331,7 +331,7 @@ void CAM_Module::putInfo( const QString& msg, const int msec ) \brief Shows the notifications with spectified text, title and automatic close timeout. Notification will be automatically closed after specified timeout in msec. If timeout is zero then automatic closing doesn't performed. - \param text - Notification text + \param message - Notification text \param title - Notification title \param timeout - Notification close timeout in msec \return notification identifier @@ -346,7 +346,7 @@ int CAM_Module::showNotification( const QString& message, const QString& title, /*! \brief Closes the notifications with spectified text. - \param text - Notification text + \param message - Notification text */ void CAM_Module::hideNotification( const QString& message ) { @@ -356,7 +356,7 @@ void CAM_Module::hideNotification( const QString& message ) /*! \brief Closes the notifications with spectified identifier. - \param text - Notification text + \param id - Notification identifier */ void CAM_Module::hideNotification( int id ) { diff --git a/src/CASCatch/CASCatch_Failure.cxx b/src/CASCatch/CASCatch_Failure.cxx index c4ecd5e27..ffe23a61b 100644 --- a/src/CASCatch/CASCatch_Failure.cxx +++ b/src/CASCatch/CASCatch_Failure.cxx @@ -74,7 +74,7 @@ Handle(CASCatch_Failure) CASCatch_Failure::Caught() //================================================================================ /*! Public - * \brief raises a CASCatch_Failure exception - * \param an exception message + * \param AString an exception message */ //================================================================================ void CASCatch_Failure::Raise (const Standard_CString AString) @@ -87,7 +87,7 @@ void CASCatch_Failure::Raise (const Standard_CString AString) //================================================================================ /*! Public - * \brief re-raises a CASCatch_Failure exception - * \param an exception message + * \param AString an exception message */ //================================================================================ void CASCatch_Failure::Reraise (const Standard_CString AString) diff --git a/src/DDS/DDS_DicGroup.cxx b/src/DDS/DDS_DicGroup.cxx index bcdcfd4de..e78aa24b4 100644 --- a/src/DDS/DDS_DicGroup.cxx +++ b/src/DDS/DDS_DicGroup.cxx @@ -72,7 +72,7 @@ TCollection_AsciiString DDS_DicGroup::GetName() const /*! \brief Get the names of all defined units systems. - \param theSystemsSeq returning sequence of names + \param theSystemSeq returning sequence of names */ void DDS_DicGroup::GetUnitSystems( TColStd_SequenceOfAsciiString& theSystemSeq ) const { @@ -91,7 +91,7 @@ void DDS_DicGroup::GetUnitSystems( TColStd_SequenceOfAsciiString& theSystemSeq ) If units system is not found, empty string is returned. - \param make units system name + \param name units system name \return units system label */ TCollection_ExtendedString DDS_DicGroup::GetUnitSystemLabel( const TCollection_AsciiString& name ) const diff --git a/src/GLViewer/GLViewer_AspectLine.cxx b/src/GLViewer/GLViewer_AspectLine.cxx index 52041ba84..a62fb4eb0 100644 --- a/src/GLViewer/GLViewer_AspectLine.cxx +++ b/src/GLViewer/GLViewer_AspectLine.cxx @@ -41,18 +41,18 @@ GLViewer_AspectLine::GLViewer_AspectLine() /*! Constructor - \param type: 0 for normal line and 1 for strip line - \param width - width of line + \param theType - 0 for normal line and 1 for strip line + \param theWidth - width of line */ -GLViewer_AspectLine::GLViewer_AspectLine( int type, float width ) +GLViewer_AspectLine::GLViewer_AspectLine( int theType, float theWidth ) { myNColor = QColor( 255, 255, 255 ); myHColor = QColor( 0, 255, 255 ); mySColor = QColor( 255, 0, 0 ); - myLineWidth = width; - if( type == 1 || type == 0 ) - myLineType = type; + myLineWidth = theWidth; + if( theType == 1 || theType == 0 ) + myLineType = theType; else myLineType = 0; } @@ -79,13 +79,13 @@ void GLViewer_AspectLine::setLineColors( QColor nc, QColor hc, QColor sc ) /*! Sets type of line - \param type: 0 for normal line and 1 for strip line + \param theType: 0 for normal line and 1 for strip line */ -int GLViewer_AspectLine::setLineType( const int type ) +int GLViewer_AspectLine::setLineType( const int theType ) { - if( type == 1 || type == 0 ) + if( theType == 1 || theType == 0 ) { - myLineType = type; + myLineType = theType; return 0; } return 1; @@ -107,15 +107,15 @@ int GLViewer_AspectLine::setLineWidth( const float width ) /*! \return colors of line - \param nc - variable for normal color - \param hc - variable for hilighting color - \param sc - variable for selection color + \param theNC - variable for normal color + \param theHC - variable for hilighting color + \param theSC - variable for selection color */ -void GLViewer_AspectLine::getLineColors( QColor& nc, QColor& hc, QColor& sc ) const +void GLViewer_AspectLine::getLineColors( QColor& theNC, QColor& theHC, QColor& theSC ) const { - nc = myNColor; - hc = myHColor; - sc = mySColor; + theNC = myNColor; + theHC = myHColor; + theSC = mySColor; } /*! diff --git a/src/GLViewer/GLViewer_AspectLine.h b/src/GLViewer/GLViewer_AspectLine.h index 359ae8190..d435679b7 100644 --- a/src/GLViewer/GLViewer_AspectLine.h +++ b/src/GLViewer/GLViewer_AspectLine.h @@ -36,7 +36,7 @@ #endif /*! - \Class GLViewer_AspectLine + \class GLViewer_AspectLine Substitution of Prs2d_AspectLine for OpenGL */ diff --git a/src/GLViewer/GLViewer_BaseObjects.cxx b/src/GLViewer/GLViewer_BaseObjects.cxx index 8451a864a..99d0b3de5 100644 --- a/src/GLViewer/GLViewer_BaseObjects.cxx +++ b/src/GLViewer/GLViewer_BaseObjects.cxx @@ -693,8 +693,8 @@ void GLViewer_MarkerSet::setSelected( const TColStd_SequenceOfInteger& seq ) } /*! Moves object by recomputing - \param dx - moving along X coord - \param dy - moving along Y coord + \param theX - moving along X coord + \param theY - moving along Y coord \param fromGroup - is true if this method called from group */ void GLViewer_MarkerSet::moveObject( float theX, float theY, bool fromGroup ) @@ -1230,8 +1230,8 @@ void GLViewer_Polyline::exportNumbers( QList& highlight, /*! Moves object by recomputing - \param dx - moving along X coord - \param dy - moving along Y coord + \param theX - moving along X coord + \param theY - moving along Y coord \param fromGroup - is true if this method called from group */ void GLViewer_Polyline::moveObject( float theX, float theY, bool fromGroup ) @@ -1545,9 +1545,9 @@ GLViewer_Rect* GLViewer_TextObject::getUpdateRect() /*! Computes highlight presentation - \param x - x coord - \param y - y coord - \param tol - tolerance of detecting + \param theX - x coord + \param theY - y coord + \param theTol - tolerance of detecting \param isCircle - true if sensitive area of detection is round \return true if highlight status is changed */ @@ -1614,10 +1614,10 @@ GLboolean GLViewer_TextObject::unhighlight() /*! Selects text object - /param x, y - co-ordinates of mouse - /param tol - tolerance - /param rect - rectangle (in case of rectangular selection) - /param isFull - if it is true, then object may selected only if it lays whole in selection zone + \param theX, theY - co-ordinates of mouse + \param theTol - tolerance + \param rect - rectangle (in case of rectangular selection) + \param isFull - if it is true, then object may selected only if it lays whole in selection zone \param isCircle - true if sensitive area of detection is round \param isShift - true if selection exec with append option */ @@ -1675,8 +1675,8 @@ GLboolean GLViewer_TextObject::unselect() /*! Moves object by recomputing - \param dx - moving along X coord - \param dy - moving along Y coord + \param theX - moving along X coord + \param theY - moving along Y coord \param fromGroup - is true if this method called from group */ void GLViewer_TextObject::moveObject( float theX, float theY, bool fromGroup ) diff --git a/src/GLViewer/GLViewer_Context.cxx b/src/GLViewer/GLViewer_Context.cxx index fc132b06d..26f781176 100644 --- a/src/GLViewer/GLViewer_Context.cxx +++ b/src/GLViewer/GLViewer_Context.cxx @@ -76,8 +76,8 @@ GLViewer_Context::~GLViewer_Context() /*! Hiilights objects under cursor - \param x - X coord of mouse cursor - \param y - Y coord of mouse cursor + \param xi - X coord of mouse cursor + \param yi - Y coord of mouse cursor \param byCircle - true if needs round sensitive area around mouse cursor, else rectangle function search object rectangle which intersect with sensitive area and call object highlight method */ @@ -498,25 +498,25 @@ bool GLViewer_Context::isSelected( GLViewer_Object* theObj ) \param display - true if needs display object immediatly after inserting, else false \param isActive - true if needs inserting object in active list */ -int GLViewer_Context::insertObject( GLViewer_Object* object, bool display, bool isActive ) +int GLViewer_Context::insertObject( GLViewer_Object* theObject, bool display, bool isActive ) { // cout << "GLViewer_Context::insertObject" << endl; - if( !object ) + if( !theObject ) return -1; if( isActive ) { - myActiveObjects.append( object ); + myActiveObjects.append( theObject ); if( display ) { - //QRect* rect = object->getRect()->toQRect(); + //QRect* rect = theObject->getRect()->toQRect(); //myGLViewer2d->updateBorders( *rect ); - myGLViewer2d->activateDrawer( object, false ); + myGLViewer2d->activateDrawer( theObject, false ); } } else - myInactiveObjects.append( object ); + myInactiveObjects.append( theObject ); return myActiveObjects.count() + myInactiveObjects.count(); } diff --git a/src/GLViewer/GLViewer_Context.h b/src/GLViewer/GLViewer_Context.h index d9d88707a..62ce39965 100644 --- a/src/GLViewer/GLViewer_Context.h +++ b/src/GLViewer/GLViewer_Context.h @@ -69,12 +69,12 @@ public: //! Main interactive method. Trace mouse in viewer window /*! - *\param x - X coord of mouse cursor - *\param y - Y coord of mouse cursor - *\paran byCircle - true if needs round sensitive area around mouse cursor, else rectangle + *\param xi - X coord of mouse cursor + *\param yi - Y coord of mouse cursor + *\param byCircle - true if needs round sensitive area around mouse cursor, else rectangle *function search object rectangle which intersect with sensitive area and call object highlight method */ - int MoveTo( int x, int y, bool byCircle = false ); + int MoveTo( int xi, int yi, bool byCircle = false ); /*! A function selecting already highlighting object by calling object method select *\param Append - true if new selection will be append to existing selection, false - another *\param byCircle - true if needs round selection area in complex object diff --git a/src/GLViewer/GLViewer_Drawer.cxx b/src/GLViewer/GLViewer_Drawer.cxx index 788efbfc9..8a6e1869e 100644 --- a/src/GLViewer/GLViewer_Drawer.cxx +++ b/src/GLViewer/GLViewer_Drawer.cxx @@ -790,7 +790,8 @@ void GLViewer_Drawer::drawTexturePart( GLuint texture, \param theFormat - text format (by default DTF_BITMAP) */ void GLViewer_Drawer::drawText( const QString& text, GLfloat xPos, GLfloat yPos, - const QColor& color, QFont* theFont, int theSeparator, DisplayTextFormat theFormat ) + const QColor& color, QFont* theFont, int theSeparator, + DisplayTextFormat theFormat ) { glColor3f( ( GLfloat )color.red() / 255, ( GLfloat )color.green() / 255, diff --git a/src/GLViewer/GLViewer_Drawer.h b/src/GLViewer/GLViewer_Drawer.h index 11acb3cef..737acd5f9 100644 --- a/src/GLViewer/GLViewer_Drawer.h +++ b/src/GLViewer/GLViewer_Drawer.h @@ -337,21 +337,21 @@ public: //! Draw text string /*! - *\param text - the text string - *\param xPos - x coord - *\param yPos - y coord - *\param color - text color - *\param aFont - base font of text - *\param theSeparator - letter separator - *\param DisplayTextFormat - text format + *\param text - the text string + *\param xPos - x coord + *\param yPos - y coord + *\param color - text color + *\param theFont - base font of text + *\param theSeparator - letter separator + *\param theFormat - text format */ void drawText( const QString& text, GLfloat xPos, - GLfloat yPos, + GLfloat yPos, const QColor& color, - QFont* aFont, + QFont* theFont, int theSeparator, - DisplayTextFormat = DTF_BITMAP ); + DisplayTextFormat theFormat = DTF_BITMAP ); //! Draw text string /*! @@ -364,8 +364,8 @@ public: *\param smallFont - font format */ void drawGLText( QString text, - float x, - float y, + float x, + float y, int hPosition = GLText_Center, int vPosition = GLText_Center, QColor color = Qt::black, diff --git a/src/GLViewer/GLViewer_Geom.cxx b/src/GLViewer/GLViewer_Geom.cxx index 07d1eca36..0c458cd07 100644 --- a/src/GLViewer/GLViewer_Geom.cxx +++ b/src/GLViewer/GLViewer_Geom.cxx @@ -42,7 +42,7 @@ GLViewer_Segment::GLViewer_Segment( const GLViewer_Pnt& thePnt1, } /*! - constructs a ray starting at and directed along positive X axis direction (or Y axis if vertical ) + constructs a ray starting at \a thePnt and directed along positive X axis direction (or Y axis if vertical ) */ GLViewer_Segment::GLViewer_Segment( const GLViewer_Pnt& thePnt, const GLfloat theA, @@ -67,7 +67,7 @@ GLViewer_Segment::~GLViewer_Segment() } /*! - detects intersection with segment + detects intersection with segment \a theOther */ bool GLViewer_Segment::HasIntersection( const GLViewer_Segment& theOther ) const { @@ -113,14 +113,14 @@ GLViewer_Poly::GLViewer_Poly( const GLViewer_PntList* thePoints ) } /*! - destructor, mustn't be deleted here! + destructor, myPoints mustn't be deleted here! */ GLViewer_Poly::~GLViewer_Poly() { } /*! - \return true if lies within this polygon + \return true if \a thePnt lies within this polygon */ bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt ) const { @@ -148,7 +148,7 @@ bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt ) const return ( aNbInter % 2 == 1 ); } /*! - \return true if lies within this polygon + \return true if \a thePnt lies within this polygon */ /* bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt, const float tolerance ) const @@ -172,7 +172,7 @@ bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt, const float tolerance ) co } */ /*! - \return true if covers this polygon + \return true if \a thePoly covers this polygon */ bool GLViewer_Poly::IsCovers( const GLViewer_Poly& thePoly ) const { @@ -191,7 +191,7 @@ bool GLViewer_Poly::IsCovers( const GLViewer_Poly& thePoly ) const } /*! - \return true if covers this polygon + \return true if \a theRect covers this polygon */ bool GLViewer_Poly::IsCovers( const GLViewer_Rect& theRect ) const { diff --git a/src/GLViewer/GLViewer_Grid.cxx b/src/GLViewer/GLViewer_Grid.cxx index bb1a2c330..8a54c3c3e 100644 --- a/src/GLViewer/GLViewer_Grid.cxx +++ b/src/GLViewer/GLViewer_Grid.cxx @@ -54,7 +54,7 @@ GLViewer_Grid::GLViewer_Grid() : \param winW and \param winH - width and height of window \param xSize and \param ySize - steps along x and y direction \param xPan and \param yPan - offsets along x and y direction - \param xScale and \param yScal - scale factors along x and y direction + \param xScale and \param yScale - scale factors along x and y direction */ GLViewer_Grid::GLViewer_Grid( GLfloat /*width*/, GLfloat /*height*/, GLfloat /*winW*/, GLfloat /*winH*/, diff --git a/src/GLViewer/GLViewer_Group.cxx b/src/GLViewer/GLViewer_Group.cxx index a40bd7bf5..e64f6a6d3 100644 --- a/src/GLViewer/GLViewer_Group.cxx +++ b/src/GLViewer/GLViewer_Group.cxx @@ -112,7 +112,7 @@ int GLViewer_Group::removeObject( GLViewer_Object* theObject ) /*! Dragging operation - \param Once is true, if this operation calls only one time for all object + \param once is true, if this operation calls only one time for all object \param x, y - dragging position */ void GLViewer_Group::dragingObjects( float x, float y, bool once ) diff --git a/src/GLViewer/GLViewer_Tools.cxx b/src/GLViewer/GLViewer_Tools.cxx index e47355b65..68dbb6ea9 100644 --- a/src/GLViewer/GLViewer_Tools.cxx +++ b/src/GLViewer/GLViewer_Tools.cxx @@ -621,7 +621,7 @@ FieldDim GLViewer_LineField::invertDim( FieldDim theFD ) /*! \return line list \param theIndex - index in list - \param tehFD - dimension + \param theFD - dimension */ GLViewer_LineList* GLViewer_LineField::getLine( int theIndex, FieldDim theFD ) { diff --git a/src/GLViewer/GLViewer_ViewPort2d.h b/src/GLViewer/GLViewer_ViewPort2d.h index 25b7315a1..c85698aee 100644 --- a/src/GLViewer/GLViewer_ViewPort2d.h +++ b/src/GLViewer/GLViewer_ViewPort2d.h @@ -146,13 +146,13 @@ public: //! Pass rect into selector and update void finishSelectByRect(); - //! \warnign It is for ouv + //! \warning It is for ouv bool startPulling( GLViewer_Pnt ); - //! \warnign It is for ouv + //! \warning It is for ouv void drawPulling( GLViewer_Pnt ); - //! \warnign It is for ouv + //! \warning It is for ouv void finishPulling(); - //! \warnign It is for ouv + //! \warning It is for ouv bool isPulling() const { return myIsPulling; } //! Returns selection by rect diff --git a/src/OBJECT/SALOME_InteractiveObject.cxx b/src/OBJECT/SALOME_InteractiveObject.cxx index e6e3d1f52..f063526be 100644 --- a/src/OBJECT/SALOME_InteractiveObject.cxx +++ b/src/OBJECT/SALOME_InteractiveObject.cxx @@ -170,7 +170,7 @@ void SALOME_InteractiveObject::setReference(const char* aReference) /*! Compare two objects \param anIO1 - first object to compare - \param anIO1 - second object to compare + \param anIO2 - second object to compare */ Standard_Boolean IsEqual(const Handle(SALOME_InteractiveObject)& anIO1, const Handle(SALOME_InteractiveObject)& anIO2) diff --git a/src/OCCViewer/OCCViewer_AxialScaleDlg.cxx b/src/OCCViewer/OCCViewer_AxialScaleDlg.cxx index 0df066b69..b4c20c4fd 100644 --- a/src/OCCViewer/OCCViewer_AxialScaleDlg.cxx +++ b/src/OCCViewer/OCCViewer_AxialScaleDlg.cxx @@ -78,7 +78,7 @@ OCCViewer_AxialScaleDlg::OCCViewer_AxialScaleDlg( OCCViewer_ViewWindow* view, OC m_sbZcoeff->setMinimumWidth( 80 ); m_sbZcoeff->setValue( 1.0 ); - // Create button + // Create Reset button m_bReset = new QPushButton( tr( "&Reset" ), aGroupBox ); // Layout widgets in the group box @@ -96,14 +96,14 @@ OCCViewer_AxialScaleDlg::OCCViewer_AxialScaleDlg( OCCViewer_ViewWindow* view, OC QHBoxLayout* aHBoxLayout2 = new QHBoxLayout( aGroupBox2 ); aHBoxLayout2->setMargin( 11 ); aHBoxLayout2->setSpacing( 6 ); - // Create button + // Create OK button QPushButton* m_bOk = new QPushButton( tr( "O&K" ), aGroupBox2 ); m_bOk->setDefault( true ); m_bOk->setAutoDefault( true ); - // Create button + // Create Apply button QPushButton* m_bApply = new QPushButton( tr( "&Apply" ), aGroupBox2 ); m_bApply->setAutoDefault( true ); - // Create button + // Create Cancel button QPushButton* m_bCancel = new QPushButton( tr( "&Cancel" ), aGroupBox2 ); m_bCancel->setAutoDefault( true ); @@ -151,7 +151,7 @@ void OCCViewer_AxialScaleDlg::Update() } /*! - \brief Called when button is pressed + \brief Called when OK button is pressed */ void OCCViewer_AxialScaleDlg::accept() { @@ -160,7 +160,7 @@ void OCCViewer_AxialScaleDlg::accept() } /*! - \brief Called when button is pressed + \brief Called when Apply button is pressed */ bool OCCViewer_AxialScaleDlg::apply() { @@ -175,7 +175,7 @@ bool OCCViewer_AxialScaleDlg::apply() } /*! - \brief Called when button is pressed + \brief Called when Reset button is pressed */ void OCCViewer_AxialScaleDlg::reset() { diff --git a/src/Qtx/QtxListBox.cxx b/src/Qtx/QtxListBox.cxx index f2e9c0c5c..695035f34 100644 --- a/src/Qtx/QtxListBox.cxx +++ b/src/Qtx/QtxListBox.cxx @@ -32,7 +32,7 @@ Constructor */ QtxListBox::QtxListBox( QWidget* parent, const char* name, WFlags f ) -: QListBox( parent, name, f ), +: QListWidget( parent, name, f ), myEditor( 0 ), myEditIndex( -1 ), myEditState( false ), @@ -116,7 +116,7 @@ void QtxListBox::setModificationEnabled( bool on ) /*! \return current edited item */ -QListBoxItem* QtxListBox::editedItem() const +QListWidgetItem* QtxListBox::editedItem() const { return item( editedIndex() ); } @@ -159,7 +159,7 @@ void QtxListBox::startEdition( const int idx ) Starts edition of item \param item - item to be edited */ -void QtxListBox::startEdition( const QListBoxItem* item ) +void QtxListBox::startEdition( const QListWidgetItem* item ) { startEdition( index( item ) ); } @@ -215,7 +215,7 @@ void QtxListBox::ensureItemVisible( const int idx ) Ensures that the item is visible. \param item - item to be made visible */ -void QtxListBox::ensureItemVisible( const QListBoxItem* item ) +void QtxListBox::ensureItemVisible( const QListWidgetItem* item ) { ensureItemVisible( index( item ) ); } @@ -275,11 +275,11 @@ void QtxListBox::moveItemToBottom( const int idx ) */ void QtxListBox::moveItem( const int idx, const int step ) { - QListBoxItem* i = item( idx ); + QListWidgetItem* i = item( idx ); if ( !i || step == 0 ) return; - QListBoxItem* cur = item( currentItem() ); + QListWidgetItem* cur = item( currentItem() ); takeItem( i ); insertItem( i, QMAX( 0, idx + step ) ); @@ -340,7 +340,7 @@ void QtxListBox::deleteItem( const int i ) */ void QtxListBox::setContentsPos( int x, int y ) { - QListBox::setContentsPos( x, y ); + QListWidget::setContentsPos( x, y ); updateEditor(); } @@ -365,7 +365,7 @@ bool QtxListBox::eventFilter( QObject* o, QEvent* e ) } } - return QListBox::eventFilter( o, e ); + return QListWidget::eventFilter( o, e ); } /*! @@ -387,7 +387,7 @@ void QtxListBox::keyPressEvent( QKeyEvent* e ) else if ( e->key() == Key_Delete && e->state() & ControlButton ) deleteItem( currentItem() ); else - QListBox::keyPressEvent( e ); + QListWidget::keyPressEvent( e ); } /*! @@ -395,7 +395,7 @@ void QtxListBox::keyPressEvent( QKeyEvent* e ) */ void QtxListBox::viewportResizeEvent( QResizeEvent* e ) { - QListBox::viewportResizeEvent( e ); + QListWidget::viewportResizeEvent( e ); updateEditor(); } @@ -408,7 +408,7 @@ void QtxListBox::mouseDoubleClickEvent( QMouseEvent* e ) if ( isEditEnabled() ) startEdition( itemAt( e->pos() ) ); else - QListBox::mouseDoubleClickEvent( e ); + QListWidget::mouseDoubleClickEvent( e ); } /*! diff --git a/src/Qtx/QtxMsgHandler.cxx b/src/Qtx/QtxMsgHandler.cxx index 6769187e2..0fa9e8f57 100644 --- a/src/Qtx/QtxMsgHandler.cxx +++ b/src/Qtx/QtxMsgHandler.cxx @@ -30,7 +30,7 @@ \code #include qInstallMessageHandler(QtxMsgHandler); - \code + \endcode To process Qt message implement a callback class by inheriting from QtxMsgHandlerCallback and override its qtMessage() function. diff --git a/src/Qtx/QtxPathListEdit.cxx b/src/Qtx/QtxPathListEdit.cxx index f68ed058f..0b1a442e7 100644 --- a/src/Qtx/QtxPathListEdit.cxx +++ b/src/Qtx/QtxPathListEdit.cxx @@ -562,7 +562,7 @@ bool QtxPathListEdit::eventFilter( QObject* o, QEvent* e ) } /*! - \brief Called when button is clicked. + \brief Called when Insert button is clicked. Inserts new empty line to the list and sets input focus to it. @@ -587,7 +587,7 @@ void QtxPathListEdit::onInsert( bool /*on*/ ) } /*! - \brief Called when button is clicked. + \brief Called when Delete button is clicked. Removes currently selected path item. @@ -603,7 +603,7 @@ void QtxPathListEdit::onDelete( bool ) } /*! - \brief Called when button is clicked. + \brief Called when Up button is clicked. Move currently selected path item up to one row in the paths list. @@ -625,7 +625,7 @@ void QtxPathListEdit::onUp( bool ) } /*! - \brief Called when button is clicked. + \brief Called when Down button is clicked. Move currently selected path item down to one row in the paths list. diff --git a/src/Qtx/QtxTreeView.cxx b/src/Qtx/QtxTreeView.cxx index 05949fa21..3e6298501 100644 --- a/src/Qtx/QtxTreeView.cxx +++ b/src/Qtx/QtxTreeView.cxx @@ -232,8 +232,8 @@ void QtxTreeView::collapseLevels( const int levels ) } /*! - \brief Expand the branch specifed by the \index and all its - children recursively. + \brief Expand the branch specifed by the \a index + and all its children recursively. \param index model index to be expanded \sa collapseAll() */ @@ -243,8 +243,8 @@ void QtxTreeView::expandAll( const QModelIndex& index ) } /*! - \brief Collapse the branch specifed by the \index and all its - children recursively. + \brief Collapse the branch specifed by the \a index + and all its children recursively. \param index model index to be collapsed \sa expandAll() */ diff --git a/src/Qtx/QtxWorkstack.cxx b/src/Qtx/QtxWorkstack.cxx index ec3fb7717..98fe4bf1d 100644 --- a/src/Qtx/QtxWorkstack.cxx +++ b/src/Qtx/QtxWorkstack.cxx @@ -347,7 +347,7 @@ void CloseButton::leaveEvent( QEvent *event ) /*! \brief Process paint event. \internal - \param event paint event + The parameter is the paint event */ void CloseButton::paintEvent( QPaintEvent* ) { @@ -3274,7 +3274,7 @@ void QtxWorkstack::splittersVisible( QWidget* wid, bool visible ) /*! \fn void QtxWorkstack::windowActivated( QWidget* w ) - \brief Emitted when the workstack's child widget \w is activated. + \brief Emitted when the workstack's child widget \a w is activated. \param w widget being activated */ diff --git a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx index d7382482f..1e6518123 100644 --- a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx +++ b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx @@ -3627,7 +3627,7 @@ bool SalomePyQt::activateView( const int id ) } /*! - \fn bool SalomePyQt::activateManagerAndView( const int id ); + \fn bool SalomePyQt::activateViewManagerAndView( const int id ); \brief Activate view manager and view: useful for a view embedded in a module main Window \param id window identifier \return \c true if operation is completed successfully and \c false otherwise @@ -3688,7 +3688,7 @@ QWidget* SalomePyQt::getViewWidget( const int id) /*! - \fn int SalomePyQt::createView( const QString& type, bool visible = true, const int width = 0, const int height = 0 ); + \fn int SalomePyQt::createView( const QString& type, bool visible = true, const int width = 0, const int height = 0, bool detached = false ); \brief Create new view and activate it \param type viewer type \param visible @@ -4697,7 +4697,7 @@ void SalomePyQt::eraseCurve( const int id, Plot2d_Curve* theCurve ) } /*! - \fn void SalomePyQt::deleteCurve( Plot2d_Curve* theCurve ) + \fn void SalomePyQt::eraseCurve( Plot2d_Curve* theCurve ) \brief Delete theCurve from all views \param theCurve curve to delete */ diff --git a/src/SUIT/SUIT_Accel.h b/src/SUIT/SUIT_Accel.h index 1622dc03a..89a1611c2 100644 --- a/src/SUIT/SUIT_Accel.h +++ b/src/SUIT/SUIT_Accel.h @@ -70,7 +70,7 @@ private: ViewerTypeIdActionMap; //!< maps viewer type to IdActionMap ViewerTypeIdActionMap myMap; //!< viewer actions map - //! Maps key to flag map, used for optimization. + //! Maps key to not_used flag map, used for optimization. //! All registered keys (accelerators) are stored in this map. QMap myOptMap; diff --git a/src/SUIT/SUIT_Application.h b/src/SUIT/SUIT_Application.h index b1688372b..869b9c5b1 100644 --- a/src/SUIT/SUIT_Application.h +++ b/src/SUIT/SUIT_Application.h @@ -87,7 +87,7 @@ public: //! Shows the application's main widget. For non GUI application must be redefined. virtual void start(); - //! Opens document into active Study. If Study is empty - creates it. + //! Opens document \a theFileName into active Study. If Study is empty - creates it. virtual bool useFile( const QString& theFileName); //! Creates new empty Study if active Study = 0 diff --git a/src/SUIT/SUIT_DataBrowser.cxx b/src/SUIT/SUIT_DataBrowser.cxx index bfe2294f9..9e6e4880a 100644 --- a/src/SUIT/SUIT_DataBrowser.cxx +++ b/src/SUIT/SUIT_DataBrowser.cxx @@ -138,7 +138,7 @@ void SUIT_DataBrowser::setUpdateModified( const bool on ) } /*! - \brief Update object browser starting from the object \obj; + \brief Update object browser starting from the object \a obj; open all branches automatically if \a autoOpen is \c true. \param obj starting object for updating \param autoOpen if \c true automatically open branches diff --git a/src/SUIT/SUIT_DataObject.cxx b/src/SUIT/SUIT_DataObject.cxx index 44a1c5acc..d19e51011 100644 --- a/src/SUIT/SUIT_DataObject.cxx +++ b/src/SUIT/SUIT_DataObject.cxx @@ -274,7 +274,6 @@ void SUIT_DataObject::children( DataObjectList& lst, const bool rec ) const /*! \brief Get all children. - \override If parameter \a rec is \c true then function collects all the children recursively. diff --git a/src/SUIT/SUIT_MessageBox.cxx b/src/SUIT/SUIT_MessageBox.cxx index b07ca2267..10ffce981 100644 --- a/src/SUIT/SUIT_MessageBox.cxx +++ b/src/SUIT/SUIT_MessageBox.cxx @@ -162,8 +162,8 @@ void SUIT_MessageBox::setButtonText( StandardButton btn, const QString& text ) \param defaultButton default button (QMessageBox::StandardButton) \return button id clicked by the user (QMessageBox::StandardButton) */ -SUIT_MessageBox::StandardButton SUIT_MessageBox::critical( QWidget* parent, const QString& title, const QString& text, - StandardButtons buttons, StandardButton defaultButton ) +QMessageBox::StandardButton SUIT_MessageBox::critical( QWidget* parent, const QString& title, const QString& text, + StandardButtons buttons, StandardButton defaultButton ) { SUIT_OverrideCursor cw( parent ? parent->cursor() : Qt::ArrowCursor ); return QMessageBox::critical( parent, title, text, buttons, defaultButton ); @@ -178,8 +178,8 @@ SUIT_MessageBox::StandardButton SUIT_MessageBox::critical( QWidget* parent, cons \param defaultButton default button (QMessageBox::StandardButton) \return button id clicked by the user (QMessageBox::StandardButton) */ -SUIT_MessageBox::StandardButton SUIT_MessageBox::warning( QWidget* parent, const QString& title, const QString& text, - SUIT_MessageBox::StandardButtons buttons, StandardButton defaultButton ) +QMessageBox::StandardButton SUIT_MessageBox::warning( QWidget* parent, const QString& title, const QString& text, + StandardButtons buttons, StandardButton defaultButton ) { SUIT_OverrideCursor cw( parent ? parent->cursor() : Qt::ArrowCursor ); return QMessageBox::warning( parent, title, text, buttons, defaultButton ); @@ -194,8 +194,8 @@ SUIT_MessageBox::StandardButton SUIT_MessageBox::warning( QWidget* parent, const \param defaultButton default button (QMessageBox::StandardButton) \return button id clicked by the user (QMessageBox::StandardButton) */ -SUIT_MessageBox::StandardButton SUIT_MessageBox::information( QWidget* parent, const QString& title, const QString& text, - StandardButtons buttons, StandardButton defaultButton ) +QMessageBox::StandardButton SUIT_MessageBox::information( QWidget* parent, const QString& title, const QString& text, + StandardButtons buttons, StandardButton defaultButton ) { SUIT_OverrideCursor cw( parent ? parent->cursor() : Qt::ArrowCursor ); return QMessageBox::information( parent, title, text, buttons, defaultButton ); @@ -210,8 +210,8 @@ SUIT_MessageBox::StandardButton SUIT_MessageBox::information( QWidget* parent, c \param defaultButton default button (QMessageBox::StandardButton) \return button id clicked by the user (QMessageBox::StandardButton) */ -SUIT_MessageBox::StandardButton SUIT_MessageBox::question( QWidget* parent, const QString& title, const QString& text, - StandardButtons buttons, StandardButton defaultButton ) +QMessageBox::StandardButton SUIT_MessageBox::question( QWidget* parent, const QString& title, const QString& text, + StandardButtons buttons, StandardButton defaultButton ) { SUIT_OverrideCursor cw( parent ? parent->cursor() : Qt::ArrowCursor ); return QMessageBox::question( parent, title, text, buttons, defaultButton ); diff --git a/src/SUIT/SUIT_MessageBox.h b/src/SUIT/SUIT_MessageBox.h index 505fe09e3..37a0b143f 100644 --- a/src/SUIT/SUIT_MessageBox.h +++ b/src/SUIT/SUIT_MessageBox.h @@ -44,13 +44,13 @@ public: void setButtonText( StandardButton, const QString& ); // message box with standard buttons - static StandardButton critical( QWidget* parent, const QString& title, const QString& text, + static QMessageBox::StandardButton critical( QWidget* parent, const QString& title, const QString& text, StandardButtons buttons = Ok, StandardButton defaultButton = NoButton ); - static StandardButton warning( QWidget* parent, const QString& title, const QString& text, + static QMessageBox::StandardButton warning( QWidget* parent, const QString& title, const QString& text, StandardButtons buttons = Ok, StandardButton defaultButton = NoButton ); - static StandardButton information( QWidget* parent, const QString& title, const QString& text, + static QMessageBox::StandardButton information( QWidget* parent, const QString& title, const QString& text, StandardButtons buttons = Ok, StandardButton defaultButton = NoButton ); - static StandardButton question( QWidget* parent, const QString& title, const QString& text, + static QMessageBox::StandardButton question( QWidget* parent, const QString& title, const QString& text, StandardButtons buttons = Ok, StandardButton defaultButton = NoButton ); // message boxes with one custom button diff --git a/src/SUIT/SUIT_TreeSync.h b/src/SUIT/SUIT_TreeSync.h index 1cbfab0ec..b12322df1 100644 --- a/src/SUIT/SUIT_TreeSync.h +++ b/src/SUIT/SUIT_TreeSync.h @@ -176,8 +176,8 @@ TrgItem synchronize( const SrcItem& r1, const TrgItem& r2, const TreeData& td ) \param first iterator pointing to the item in the list \a l from which search shoud be started \param last iterator pointing to the item in the list \a l the search to be finished at \param td functor class - \return iterator pointing to the item in the list \l if the correspondence is found or iterator - \a last if the correspondence is not found + \return iterator pointing to the item in the list \a l if the correspondence is found + or iterator \a last if the correspondence is not found \sa synchronize() */ template diff --git a/src/SUIT/SUIT_ViewManager.cxx b/src/SUIT/SUIT_ViewManager.cxx index 398a54309..df8451cf5 100644 --- a/src/SUIT/SUIT_ViewManager.cxx +++ b/src/SUIT/SUIT_ViewManager.cxx @@ -39,7 +39,7 @@ QMap SUIT_ViewManager::_ViewMgrId; /*!\class SUIT_ViewManager. - * Class provide manipulation with view windows. + * \brief Thsi class provides manipulation with view windows. */ /*!Constructor.*/ diff --git a/src/SVTK/SVTK_AreaPicker.h b/src/SVTK/SVTK_AreaPicker.h index 9ad82acb8..772068541 100644 --- a/src/SVTK/SVTK_AreaPicker.h +++ b/src/SVTK/SVTK_AreaPicker.h @@ -46,7 +46,7 @@ class vtkRenderer; #endif /*! \class vtkAbstractPropPicker - * \brief For more information see VTK documentation + * \brief For more information see VTK documentation */ /*! \class SVTK_AreaPicker * \brief Rectangular picker class. diff --git a/src/SVTK/SVTK_InteractorStyle.cxx b/src/SVTK/SVTK_InteractorStyle.cxx index 92c2b8199..6884a4623 100644 --- a/src/SVTK/SVTK_InteractorStyle.cxx +++ b/src/SVTK/SVTK_InteractorStyle.cxx @@ -756,7 +756,7 @@ void SVTK_InteractorStyle::OnRightButtonDown(int ctrl, To handle right mouse button up event (reimplemented from vtkInteractorStyle) */ void SVTK_InteractorStyle::OnRightButtonUp(int vtkNotUsed(ctrl), - int shift, + int shift, int vtkNotUsed(x), int vtkNotUsed(y)) { diff --git a/src/SVTK/SVTK_ViewModel.h b/src/SVTK/SVTK_ViewModel.h index c886fa774..3df1aae8a 100644 --- a/src/SVTK/SVTK_ViewModel.h +++ b/src/SVTK/SVTK_ViewModel.h @@ -48,7 +48,7 @@ class SVTK_EXPORT SVTK_Viewer : public SVTK_ViewModelBase, public SALOME_View public: /*! supported gradient types */ - enum { + enum { HorizontalGradient, VerticalGradient, FirstDiagonalGradient, @@ -184,7 +184,7 @@ public: /* Reimplemented from SALOME_View */ - //! See #SALOME_View::Display( const SALOME_Prs* ) + //! See #SALOME_View::Display( const SALOME_VTKPrs* ) void Display( const SALOME_VTKPrs* ); //! See #SALOME_View::Erase( const SALOME_VTKPrs*, const bool = false ) @@ -193,13 +193,13 @@ public: //! See #SALOME_View::EraseAll( SALOME_Displayer*, const bool = false ) void EraseAll( SALOME_Displayer*, const bool = false ); - //! See #SALOME_View::getVisible( SALOME_ListIO& ) + //! See #SALOME_View::GetVisible( SALOME_ListIO& ) virtual void GetVisible( SALOME_ListIO& ); //! See #SALOME_View::CreatePrs( const char* entry = 0 ) SALOME_Prs* CreatePrs( const char* entry = 0 ); - //! See #SALOME_View::isVisible( const Handle(SALOME_InteractiveObject)& ) + //! See #SALOME_View::isVisible( const Handle& ) virtual bool isVisible( const Handle(SALOME_InteractiveObject)& ); //! See #SALOME_View::Repaint() diff --git a/src/SVTK/SVTK_ViewWindow.h b/src/SVTK/SVTK_ViewWindow.h index 49cac7f51..1fbf03795 100644 --- a/src/SVTK/SVTK_ViewWindow.h +++ b/src/SVTK/SVTK_ViewWindow.h @@ -379,7 +379,7 @@ public slots: //! Redirect the request to #SVTK_Renderer::OnFitAll virtual void onFitAll(); - //! Redirect the request to #SVTK_Renderer::OnFitSelection + //! Redirect the request to #SVTK_Renderer::onFitSelection virtual void onFitSelection(); //! Redirect the request to #SVTK_Renderer::OnFitIObjects diff --git a/src/SalomeApp/Test/TestSalomeApp.cxx b/src/SalomeApp/Test/TestSalomeApp.cxx index 1e31f83b2..8023dd09f 100644 --- a/src/SalomeApp/Test/TestSalomeApp.cxx +++ b/src/SalomeApp/Test/TestSalomeApp.cxx @@ -23,7 +23,8 @@ #include /*! - \class SalomeAppTest: test suit + \class SalomeAppTest + \brief Test suit */ class SalomeAppTest : public CppUnit::TestFixture { diff --git a/src/TOOLSGUI/ToolsGUI.cxx b/src/TOOLSGUI/ToolsGUI.cxx index 8b69b4d0a..aa3c8ab5f 100644 --- a/src/TOOLSGUI/ToolsGUI.cxx +++ b/src/TOOLSGUI/ToolsGUI.cxx @@ -55,8 +55,8 @@ bool ToolsGUI::GetVisibility( _PTR(SObject) theObj, /*! \brief Set visibility value of the "AttributeGraphic" attribute. - \param theObj object - \return theValue new visibility value + \param theEntry object entry + \param theValue new visibility value \param theId sub-object identifier */ bool ToolsGUI::SetVisibility( const char* theEntry, diff --git a/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.cxx b/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.cxx index 8a2de8ff8..31ecc2089 100644 --- a/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.cxx +++ b/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.cxx @@ -367,7 +367,7 @@ void ToolsGUI_CatalogGeneratorDlg::onBrowseBtnClicked() } /*! - \brief Update button's state. + \brief Update OK button's state. */ void ToolsGUI_CatalogGeneratorDlg::updateButtonState() { @@ -376,7 +376,7 @@ void ToolsGUI_CatalogGeneratorDlg::updateButtonState() } /*! - \brief Called when user presses button + \brief Called when user presses Apply button Performs IDL to XML file conversion using \c runIDLparser SALOME utility. */ diff --git a/src/VTKViewer/VTKViewer_Algorithm.h b/src/VTKViewer/VTKViewer_Algorithm.h index 5a6209493..042d22555 100644 --- a/src/VTKViewer/VTKViewer_Algorithm.h +++ b/src/VTKViewer/VTKViewer_Algorithm.h @@ -61,7 +61,7 @@ namespace VTK vtkActorCollection* GetActors() const; }; - /*!For each actor(for ex: someActor) from \a theCollection(that can be dynamic cast to type TActor)\n + /*!For each actor(for ex: someActor) from \a theCollection(that can be dynamic cast to type TActor) * Call method \a theFun(someActor) */ template @@ -94,7 +94,7 @@ namespace VTK } return theFun; } - + /*!Find actor from collection, that can be dynamicaly cast to \a TActor, \n *and method \a thePredicate(someActor) return true) \n *\retval someActor diff --git a/src/VTKViewer/VTKViewer_AppendFilter.h b/src/VTKViewer/VTKViewer_AppendFilter.h index 158ab150c..8baa49ae0 100644 --- a/src/VTKViewer/VTKViewer_AppendFilter.h +++ b/src/VTKViewer/VTKViewer_AppendFilter.h @@ -46,9 +46,7 @@ public: */ static VTKViewer_AppendFilter *New(); - /*! \fn vtkTypeMacro(VTKViewer_AppendFilter, vtkAppendFilter) - * \brief VTK type revision macros. - */ + // VTK type revision macros. vtkTypeMacro(VTKViewer_AppendFilter, vtkAppendFilter) void SetDoMappingFlag(const bool theFlag); diff --git a/src/VTKViewer/VTKViewer_Filter.cxx b/src/VTKViewer/VTKViewer_Filter.cxx index 118fd4fa6..92082d208 100644 --- a/src/VTKViewer/VTKViewer_Filter.cxx +++ b/src/VTKViewer/VTKViewer_Filter.cxx @@ -49,7 +49,7 @@ VTKViewer_Filter::~VTKViewer_Filter() * call virtual method IsValid( const int theId ). * \param theActor - actor * \param theCellId - cell id. - * \retval \c true - if cell id is valid, else \c false. + * \retval true - if cell id is valid, else \c false. */ bool VTKViewer_Filter::IsValid( VTKViewer_Actor* theActor, const vtkIdType theCellId ) { diff --git a/src/VTKViewer/VTKViewer_GeometryFilter.h b/src/VTKViewer/VTKViewer_GeometryFilter.h index af65b0267..b3c11e3c7 100644 --- a/src/VTKViewer/VTKViewer_GeometryFilter.h +++ b/src/VTKViewer/VTKViewer_GeometryFilter.h @@ -45,10 +45,9 @@ public: */ static VTKViewer_GeometryFilter *New(); - /*! \fn vtkTypeMacro(VTKViewer_GeometryFilter, vtkGeometryFilter) - * \brief VTK type revision macros. - */ + // VTK type revision macros. vtkTypeMacro(VTKViewer_GeometryFilter, vtkGeometryFilter) + /*! \fn void SetInside(int theShowInside) * \brief Sets \a myShowInside flag. \a myShowInside is changed, call this->Modified(). * \param theShowInside - used for changing value of \a myShowInside variable. diff --git a/src/VTKViewer/VTKViewer_InteractorStyle.cxx b/src/VTKViewer/VTKViewer_InteractorStyle.cxx index c2e1f862d..246869744 100644 --- a/src/VTKViewer/VTKViewer_InteractorStyle.cxx +++ b/src/VTKViewer/VTKViewer_InteractorStyle.cxx @@ -674,7 +674,7 @@ void VTKViewer_InteractorStyle::startGlobalPan() } -/*!\retval \c true if needs redrawing*/ +/*!\retval true if needs redrawing*/ bool VTKViewer_InteractorStyle::needsRedrawing() { return State == VTK_INTERACTOR_STYLE_CAMERA_ZOOM || diff --git a/src/VTKViewer/VTKViewer_MarkerDlg.cxx b/src/VTKViewer/VTKViewer_MarkerDlg.cxx index 3ad3e23a6..aab8edabc 100644 --- a/src/VTKViewer/VTKViewer_MarkerDlg.cxx +++ b/src/VTKViewer/VTKViewer_MarkerDlg.cxx @@ -182,7 +182,7 @@ VTK::MarkerScale VTKViewer_MarkerDlg::markerScale() const } /*! - \bried Get currently selected custom marker's identifier. + \brief Get currently selected custom marker's identifier. For standard markers return value is VTK::MT_NONE. */ int VTKViewer_MarkerDlg::markerId() const diff --git a/src/VTKViewer/VTKViewer_MarkerWidget.cxx b/src/VTKViewer/VTKViewer_MarkerWidget.cxx index c1e13dc0e..91937b820 100644 --- a/src/VTKViewer/VTKViewer_MarkerWidget.cxx +++ b/src/VTKViewer/VTKViewer_MarkerWidget.cxx @@ -190,7 +190,7 @@ VTK::MarkerScale VTKViewer_MarkerWidget::markerScale() const } /*! - \bried Get currently selected custom marker's identifier. + \brief Get currently selected custom marker's identifier. For standard markers return value is VTK::MT_NONE. */ int VTKViewer_MarkerWidget::markerId() const diff --git a/src/VTKViewer/VTKViewer_Trihedron.h b/src/VTKViewer/VTKViewer_Trihedron.h index c0b31853d..9e280110e 100644 --- a/src/VTKViewer/VTKViewer_Trihedron.h +++ b/src/VTKViewer/VTKViewer_Trihedron.h @@ -109,7 +109,7 @@ public: #endif /*! Sets Arrow actor. - * \param theLabelActor - VTKViewer_UnScaledActor + * \param theArrowActor - VTKViewer_UnScaledActor */ void SetArrowActor(vtkFollower* theArrowActor); -- 2.39.2