X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FICoCo%2FICoCoField.hxx;h=ea4959e2ef033e126554e638f0329f5b18e8b1ea;hb=490dddcbdaa4272528887a2bbaaf345c11e28cad;hp=f04cb58aef758be5e983057f5b78770ead4b7b37;hpb=b33408f1dc045a4d0f2e16d22f4930d7029996a3;p=tools%2Fmedcoupling.git

diff --git a/src/ICoCo/ICoCoField.hxx b/src/ICoCo/ICoCoField.hxx
index f04cb58ae..ea4959e2e 100644
--- a/src/ICoCo/ICoCoField.hxx
+++ b/src/ICoCo/ICoCoField.hxx
@@ -17,27 +17,48 @@
 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
-// ICoCo file common to several codes
-// ICoCoField.h
-// version 1.2 10/05/2010
+// WARNING: this file is part of the official ICoCo API and should not be modified.
+// The official version can be found at the following URL:
+//
+//    https://github.com/cea-trust-platform/icoco-coupling
 
-#ifndef _ICoCoField_included_
-#define _ICoCoField_included_
+#ifndef ICoCoField_included
+#define ICoCoField_included
 #include <string>
 
+#include "ICoCo.hxx"
 
-namespace ICoCo {
-
-  class Field {
+namespace ICoCo
+{
+  /*! @brief Top abstract class defining field objects that can be exchanged via the ICoCo interface.
+   *
+   * The Field class holds the name of the field.
+   */
+  class MEDCOUPLINGICOCO_EXPORT Field
+  {
   public:
-    Field();
-    virtual ~Field();
+    /*! @brief Set the name of the field.
+     * @param name name of the field
+     */
     void setName(const std::string& name);
+
+    /*! @brief Retrieves the name of the field.
+     * @return name of the field.
+     */
     const std::string& getName() const;
+
+    /*!
+     * @brief Retrieves the name of the field as a char *
+     * @return name of the field.
+     */
     const char* getCharName() const;
-    
+
+  protected:
+    Field();
+    virtual ~Field();
+
   private:
     std::string* _name;
   };
-}
+} // namespace ICoCo
 #endif