From f86b5deec77d99db818107e8b8b320b74008031b Mon Sep 17 00:00:00 2001 From: ribes Date: Wed, 28 Feb 2007 15:06:54 +0000 Subject: [PATCH] Doxygen documentation and english comments --- src/DSC/DSC_Basic/PortProperties_i.cxx | 6 +++--- src/DSC/DSC_Basic/PortProperties_i.hxx | 19 +++++++++++++++---- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/src/DSC/DSC_Basic/PortProperties_i.cxx b/src/DSC/DSC_Basic/PortProperties_i.cxx index 79ebab02b..a4a0947a7 100644 --- a/src/DSC/DSC_Basic/PortProperties_i.cxx +++ b/src/DSC/DSC_Basic/PortProperties_i.cxx @@ -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(); } diff --git a/src/DSC/DSC_Basic/PortProperties_i.hxx b/src/DSC/DSC_Basic/PortProperties_i.hxx index d39d7b897..a6e713b58 100644 --- a/src/DSC/DSC_Basic/PortProperties_i.hxx +++ b/src/DSC/DSC_Basic/PortProperties_i.hxx @@ -19,7 +19,7 @@ // // // -// File : ConnectionManager_i.hxx +// File : PortProperties_i.hxx // Author : André RIBES (EDF) // Module : KERNEL @@ -29,6 +29,9 @@ #include #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 - - -- 2.39.2