]> SALOME platform Git repositories - modules/med.git/commitdiff
Salome HOME
Doc: indicating functions returning a borrowed ref in MEDLoader
authorabn <adrien.bruneton@cea.fr>
Wed, 16 Apr 2014 08:34:00 +0000 (10:34 +0200)
committerabn <adrien.bruneton@cea.fr>
Wed, 16 Apr 2014 08:34:00 +0000 (10:34 +0200)
src/MEDLoader/MEDFileData.cxx
src/MEDLoader/MEDFileMesh.cxx

index 82687b1bbd01f44062df42b8ff8dea4956c261ee..ffac18050287b8f4c3e38a2ce9fa851e089f98cb 100644 (file)
@@ -66,16 +66,19 @@ std::vector<const BigMemoryObject *> MEDFileData::getDirectChildren() const
 
 }
 
+/** Return a borrowed reference (caller is not responsible for object destruction) */
 MEDFileFields *MEDFileData::getFields() const
 {
   return const_cast<MEDFileFields *>(static_cast<const MEDFileFields *>(_fields));
 }
 
+/** Return a borrowed reference (caller is not responsible for object destruction) */
 MEDFileMeshes *MEDFileData::getMeshes() const
 {
   return const_cast<MEDFileMeshes *>(static_cast<const MEDFileMeshes *>(_meshes));
 }
 
+/** Return a borrowed reference (caller is not responsible for object destruction) */
 MEDFileParameters *MEDFileData::getParams() const
 {
   return const_cast<MEDFileParameters *>(static_cast<const MEDFileParameters *>(_params));
index 6360c2a9ed17168051b0aeadb24cf0b7eaae5c2f..b68a6fa748d6386d5d7d9e30410e66cb6c171d03 100644 (file)
@@ -5673,6 +5673,7 @@ MEDFileMeshesIterator *MEDFileMeshes::iterator()
   return new MEDFileMeshesIterator(this);
 }
 
+/** Return a borrowed reference (caller is not responsible) */
 MEDFileMesh *MEDFileMeshes::getMeshAtPos(int i) const
 {
   if(i<0 || i>=(int)_meshes.size())
@@ -5683,6 +5684,7 @@ MEDFileMesh *MEDFileMeshes::getMeshAtPos(int i) const
   return _meshes[i]->getOneTimeStep();
 }
 
+/** Return a borrowed reference (caller is not responsible) */
 MEDFileMesh *MEDFileMeshes::getMeshWithName(const std::string& mname) const
 {
   std::vector<std::string> ms=getMeshesNames();