X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FCAM%2FCAM_Study.cxx;h=421bb457a469962d82ad5ea4846642cec0b7b290;hb=01505a1a6ad722fe16dcece0fcc1be8807ae26a0;hp=cdf05adc8081acd4bab7b626ac759b716dd9f5e3;hpb=2e750f9ded92337bc3c44e9d7388180974cc4a43;p=modules%2Fgui.git

diff --git a/src/CAM/CAM_Study.cxx b/src/CAM/CAM_Study.cxx
index cdf05adc8..421bb457a 100755
--- a/src/CAM/CAM_Study.cxx
+++ b/src/CAM/CAM_Study.cxx
@@ -5,34 +5,51 @@
 #include "CAM_RootObject.h"
 #include "CAM_Module.h"
 
+/*!Constructor.*/
 CAM_Study::CAM_Study( SUIT_Application* app )
 : SUIT_Study( app )
 {
 }
 
+/*!Destructor*/
 CAM_Study::~CAM_Study()
 {
 }
 
-void CAM_Study::closeDocument()
+/*!Closing all data models and close document permanently(if \a permanently = true.)
+ * \param permanently - flag
+ */
+void CAM_Study::closeDocument(bool permanently)
 {
   for ( ModelListIterator it( myDataModels ); it.current(); ++it )
     it.current()->close();
 
-  SUIT_Study::closeDocument();
+  SUIT_Study::closeDocument(permanently);
 }
 
+/*!Append data model to list.
+ * \param dm - data model for adding
+ */
 bool CAM_Study::appendDataModel( const CAM_DataModel* dm )
 {
   return insertDataModel( dm, myDataModels.count() );
 }
 
+/*!Insert data model \a dm after \a other
+ * \param dm - data model for adding
+ * \param other - previus data model for \a dm
+ */
 bool CAM_Study::insertDataModel( const CAM_DataModel* dm, const CAM_DataModel* other )
 {
   int idx = myDataModels.findRef( other );
   return insertDataModel( dm, idx < 0 ? idx : idx + 1 );
 }
 
+/*!Insert data model with index \a idx. \n
+ * \param dm - data model
+ * \param idx - index for inserting(must be no less zero)
+ * \retval true - if model added successful, else false.
+ */
 bool CAM_Study::insertDataModel( const CAM_DataModel* dm, const int idx )
 {
   if ( !dm || myDataModels.findRef( dm ) != -1 )
@@ -48,6 +65,10 @@ bool CAM_Study::insertDataModel( const CAM_DataModel* dm, const int idx )
   return true;
 }
 
+/*! Remove data model from list
+ * \param dm data model
+ * \retval true - if all ok, else false.
+ */
 bool CAM_Study::removeDataModel( const CAM_DataModel* dm )
 {
   if ( !dm )
@@ -60,11 +81,18 @@ bool CAM_Study::removeDataModel( const CAM_DataModel* dm )
   return myDataModels.remove( dm );
 }
 
+/*!Check data model contains in list.
+ * \param dm - data model
+ * \retval true - if data model in list, else false.
+ */
 bool CAM_Study::containsDataModel( const CAM_DataModel* dm ) const
 {
   return myDataModels.contains( dm );
 }
 
+/*!Gets list of all data models.
+ * \param lst - output data model list.
+ */
 void CAM_Study::dataModels( ModelList& lst ) const
 {
   lst.clear();
@@ -72,6 +100,7 @@ void CAM_Study::dataModels( ModelList& lst ) const
     lst.append( it.current() );
 }
 
+/*! Open data model \a dModel, if it saved*/
 void CAM_Study::dataModelInserted( const CAM_DataModel* dModel )
 {
   CAM_DataModel* dm = (CAM_DataModel*)dModel;
@@ -86,16 +115,19 @@ void CAM_Study::dataModelInserted( const CAM_DataModel* dModel )
   }
 }
 
+/*! \retval false*/
 bool CAM_Study::openDataModel( const QString&, CAM_DataModel* )
 {
   return false;
 }
 
+/*! \retval false*/
 bool CAM_Study::saveDataModel( const QString&, CAM_DataModel* )
 {
   return false;
 }
 
+/*! Public slot. Update model root.*/
 void CAM_Study::updateModelRoot( const CAM_DataModel* dm )
 {
   if ( !root() )