]> SALOME platform Git repositories - modules/kernel.git/commitdiff
Salome HOME
Doxygen documentation and english comments
authorribes <ribes>
Wed, 28 Feb 2007 15:06:54 +0000 (15:06 +0000)
committerribes <ribes>
Wed, 28 Feb 2007 15:06:54 +0000 (15:06 +0000)
src/DSC/DSC_Basic/PortProperties_i.cxx
src/DSC/DSC_Basic/PortProperties_i.hxx

index 79ebab02b12d307a7220cda5f170a1e55620e3eb..a4a0947a7afadd9c9ab5ac0435d520ffc6006360 100644 (file)
@@ -19,7 +19,7 @@
 //
 //
 //
-//  File   : PortProperties.cxx
+//  File   : PortProperties_i.cxx
 //  Author : André RIBES (EDF)
 //  Module : KERNEL
 
@@ -33,7 +33,7 @@ void
 PortProperties_i::set_property(const char * name, const CORBA::Any& value)
   throw (Ports::NotDefined, Ports::BadType)
 {
-  // Default ...
+  // Default case, the object has no properties.
   throw Ports::NotDefined();
 }
 
@@ -41,7 +41,7 @@ CORBA::Any*
 PortProperties_i::get_property(const char* name)
   throw (Ports::NotDefined)
 {
-  // Default ...
+  // Default case, the object has no properties.
   throw Ports::NotDefined();
 }
 
index d39d7b897787affbfdd44b77a558b6d7d92fb8cf..a6e713b586c33e3c993d4f472e48adae4dd19aea 100644 (file)
@@ -19,7 +19,7 @@
 //
 //
 //
-//  File   : ConnectionManager_i.hxx
+//  File   : PortProperties_i.hxx
 //  Author : André RIBES (EDF)
 //  Module : KERNEL
  
@@ -29,6 +29,9 @@
 #include <SALOMEconfig.h>
 #include CORBA_SERVER_HEADER(SALOME_Ports)
 
+/*! \class PortProperties_i
+ *  \brief This class implements the interface Ports::PortProperties.
+ */
 class PortProperties_i:
   public virtual POA_Ports::PortProperties
 {
@@ -36,12 +39,20 @@ class PortProperties_i:
     PortProperties_i();
     virtual ~PortProperties_i();
 
-    virtual void set_property(const char * name, const CORBA::Any& value)
+    /*!
+     * CORBA method : set a value to a property
+     * \see Ports::PortProperties::set_property
+     */
+    virtual void set_property(const char * name,
+                             const CORBA::Any& value)
       throw (Ports::NotDefined, Ports::BadType);
+
+    /*!
+     * CORBA method : get the value of a property
+     * \see Ports::PortProperties::get_property
+     */
     virtual CORBA::Any* get_property(const char* name)
       throw (Ports::NotDefined);
 };
 
 #endif
-
-