]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Fix some doxygen documentation problems and compiler warnings
authormpv <mpv@opencascade.com>
Fri, 6 May 2016 06:42:38 +0000 (09:42 +0300)
committermpv <mpv@opencascade.com>
Fri, 6 May 2016 06:42:38 +0000 (09:42 +0300)
src/ConnectorPlugin/ConnectorPlugin_ExportFeature.py
src/Events/Events_Error.h
src/Model/Model_AttributeSelectionList.h
src/Model/Model_SelectionNaming.cpp
src/Model/Model_Update.h
src/ModelAPI/ModelAPI_AttributeSelectionList.h
src/ModelAPI/ModelAPI_Events.h
src/ModelAPI/ModelAPI_Feature.h
src/XGUI/XGUI_MenuMgr.cpp

index 31db8fc9a78ee751798abeef284d32794b8af121..e9cb9804f1813430747dd8965363f74c09982532 100644 (file)
@@ -27,6 +27,10 @@ class ExportFeature(ModelAPI.ModelAPI_Feature):
     ## The constructor.
     def __init__(self):
         ModelAPI.ModelAPI_Feature.__init__(self)
+        ## Shape that will be exported (the compound if there are several exported bodies)
+        self.shape = None
+        ## BRep representation of the exported shape (a stream that will be sent to GEOM and converted to GEOM object)
+        self.brep = None
 
     @staticmethod
     ## Export kind. Static.
index b344c6e36f9a3319939a1d351e4247158a9d9d27..aefa5dd73f224f52e455ed6e713d08f83a387b1f 100644 (file)
@@ -38,7 +38,7 @@ public:
   EVENTS_EXPORT static void send(const std::string& theDescription, const void* theSender = 0);
 
   /// Throws a C++ exception about using an empty AIS object
-  /// \theDescription an exception information
+  /// \param theDescription an exception information
   EVENTS_EXPORT static void throwException(const std::string& theDescription);
 
 protected:
index c0f36fd7cf480e3628cb6cefdd61b859ce70da31..3c6317d5ab4a06ccf685254c941e1e29b5f25657 100644 (file)
@@ -57,6 +57,7 @@ public:
   /// Returns true if the object with the shape are in list
   /// \param theContext object where the sub-shape was selected
   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
+  /// \param theTemporarily if it is true, it checks also the temporary added item
   /// \returns true if the pair is found in the attirbute
   MODEL_EXPORT virtual bool isInList(
     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
index 2a776e624544f14d6b1c0b8d7f5c0e65302ebdcb..167d3b93574afebf9d69d02d2ee01071dfc601d2 100644 (file)
@@ -335,11 +335,11 @@ const TopoDS_Shape findFaceByName(
   return aFace;
 }
 
-int ParseName(const std::string& theSubShapeName,   std::list<std::string>& theList)
+size_t ParseName(const std::string& theSubShapeName,   std::list<std::string>& theList)
 {
   std::string aName = theSubShapeName;
   std::string aLastName;
-  int n1(0), n2(0); // n1 - start position, n2 - position of the delimiter
+  size_t n1(0), n2(0); // n1 - start position, n2 - position of the delimiter
   while ((n2 = aName.find('&', n1)) != std::string::npos) {
     const std::string aName1 = aName.substr(n1, n2 - n1); //name of face
     theList.push_back(aName1); 
@@ -495,7 +495,7 @@ bool Model_SelectionNaming::selectSubShape(const std::string& theType,
       }
       if(aSelection.IsNull()) {
         std::list<std::string> aListofNames;
-        int n = ParseName(theSubShapeName, aListofNames);
+        size_t n = ParseName(theSubShapeName, aListofNames);
         if(n > 1 && n < 5) {
           TopTools_ListOfShape aList;
           std::list<std::string>::iterator it =aListofNames.begin();
@@ -527,7 +527,7 @@ bool Model_SelectionNaming::selectSubShape(const std::string& theType,
       }
       if(aSelection.IsNull()) {
         std::list<std::string> aListofNames;
-        int n = ParseName(theSubShapeName, aListofNames);
+        size_t n = ParseName(theSubShapeName, aListofNames);
         if(n > 1 && n < 4) { // 2 || 3
           TopTools_ListOfShape aList;
           std::list<std::string>::iterator it = aListofNames.begin();
index 50199c8c3a97e28cc45312b7849a9cfbb719dc96..7eb4a8ef2e9424fd342efe8841a3b9cd8b2f92c0 100644 (file)
@@ -72,7 +72,6 @@ protected:
     const ModelAPI_ExecState theState);
 
   /// On operation start/end/abort the "Just" fileds must be cleared and processed in the right way
-  /// \param theFinish is true for start, close or abort transaction: all objects must be processed
   //! \param theFlushRedisplay a boolean value if the redisplay signal should be flushed
   void processFeatures(const bool theFlushRedisplay = true);
 
index 9f0b0a69aafb844d031a48b2e9b1a214a22a7b22..aa2e7291574ae0eda5d55c77f5fcbff109a92d59 100644 (file)
@@ -45,6 +45,7 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
   /// Returns true if the object with the shape are in list
   /// \param theContext object where the sub-shape was selected
   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
+  /// \param theTemporarily if it is true, it checks also the temporary added item
   /// \returns true if the pair is found in the attirbute
   virtual bool isInList(
     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
index aee15049df32f206e15464d046517b684769cbdc..1bbf8d2fb81413542cb027e73d9d1b0d616a07a5 100644 (file)
@@ -311,11 +311,13 @@ class ModelAPI_ReplaceParameterMessage : public Events_Message
   MODELAPI_EXPORT void setObject(ObjectPtr theObject);
 };
 
-
+/// Message that sends the sketch solver and sketcher GUI processes to show in the property panel
 class ModelAPI_SolverFailedMessage : public Events_Message
 {
 public:
+  /// Creates an message
   MODELAPI_EXPORT ModelAPI_SolverFailedMessage(const Events_ID theID, const void* theSender = 0);
+  /// Default destructor
   MODELAPI_EXPORT virtual ~ModelAPI_SolverFailedMessage();
 
   /// Sets list of conflicting constraints
index a9fc2f07717f1f7141f539adbd316f7656d0c424..66eb18225d371b0cd2ba02b94a0b50581c36a0dc 100644 (file)
@@ -142,8 +142,8 @@ class ModelAPI_Feature : public ModelAPI_Object
   /// Returns the feature is stable or not.
   MODELAPI_EXPORT virtual bool isStable();
 
-  /// Performs some functionality for the indes
-  /// \param theAttributeId an action key
+  /// Performs some custom feature specific functionality (normally called by some GUI button)
+  /// \param theActionId an action key
   /// \return a boolean value about it is performed
   MODELAPI_EXPORT virtual bool customAction(const std::string& theActionId);
 
index 9ee7ed9e972cb22cdf93c2ff6372327efa5709da..57acc07cb430bb4665e309232a720b47b2bb9018 100755 (executable)
@@ -171,7 +171,7 @@ void XGUI_MenuMgr::createFeatureActions()
 QAction* XGUI_MenuMgr::buildAction(const std::shared_ptr<Config_FeatureMessage>& theMessage,
                                    const std::string& theWchName, const bool aUseSeparator) const
 {
-  QAction* anAction;
+  QAction* anAction = 0;
 
 #ifdef HAVE_SALOME
   XGUI_SalomeConnector* aSalomeConnector = myWorkshop->salomeConnector();