X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=idl%2FSALOME_Ports.idl;h=d3d80f2902887911df4d66b034beff3fa0df9941;hb=1dd774781b78b19e4d3c26c3a461141a0fb6ab93;hp=4408561bc180e4a12b354378b9625d80a4fb4cb7;hpb=7d2fe213bdf5bf962ce11e253020c9d3e0bc1cce;p=modules%2Fkernel.git

diff --git a/idl/SALOME_Ports.idl b/idl/SALOME_Ports.idl
index 4408561bc..d3d80f290 100644
--- a/idl/SALOME_Ports.idl
+++ b/idl/SALOME_Ports.idl
@@ -1,36 +1,38 @@
-//  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
 //
-//  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
 //
-//  This library is free software; you can redistribute it and/or
-//  modify it under the terms of the GNU Lesser General Public
-//  License as published by the Free Software Foundation; either
-//  version 2.1 of the License.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License.
 //
-//  This library is distributed in the hope that it will be useful,
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-//  Lesser General Public License for more details.
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
-//  You should have received a copy of the GNU Lesser General Public
-//  License along with this library; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-//  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
+
 //  File   : SALOME_Ports.idl
 //  Author : Andre RIBES, EDF
-//  $Header:
 //
 #ifndef _SALOME_PORTS_IDL_
 #define _SALOME_PORTS_IDL_
 
-/*! \file
-  This file contains the IDL declarations of the kind of ports provided by the 
-  SALOME component model.
+/*! \file SALOME_Ports.idl
+  \brief This file contains the IDL base interfaces for ports in the SALOME component model.
  */
 
+/*! \brief module that contains interfaces to define the kind of ports provided by the
+SALOME component model.
+*/
 module Ports {
   
   /*! \brief Interface of a DSC Port.
@@ -68,21 +70,13 @@ module Ports {
   */
   interface Data_And_Control_Port : Ports::Port {};
 
-  /*!
-    This exception indicates that the property doesn't not exist.
-  */
+  //!  This exception indicates that the property doesn't not exist.
   exception NotDefined {};
 
-  /*!
-    This exception indicates that the given value to the property is not
-    of a good type.
-  */
+  //!  This exception indicates that the given value to the property is not of a good type.
   exception BadType {};
 
-  /*!
-    This exception indicates that the given value to the property is not
-    authorized.
-  */
+  //!  This exception indicates that the given value to the property is not authorized.
   exception BadValue {};
 
   /*! \brief Interface of a PortProperties.
@@ -92,8 +86,8 @@ module Ports {
   */
   interface PortProperties {
     
+    //!  This operation permits to set a value of a property.
     /*!
-      This operation permits to set a value of a property.
 
       \param name property's name.
       \param value value of the property.
@@ -105,8 +99,8 @@ module Ports {
 							    Ports::BadValue,
 							    Ports::NotDefined);
 
+    //!  This operation permits to get property's value.
     /*!
-      This operation permits to get property's value.
 
       \param name property's name.
       \return value of the property.
@@ -122,6 +116,7 @@ module Ports {
     a port in the DSC_User programming model.
   */
   interface Data_Short_Port : Ports::Data_Port {
+    //! this operation can be used by a uses port to send me a short 
     void put(in short data);
   };
 };