added documentation note (regarding std::ios_base::openmode flags) for read with istream

git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@752 fdac6126-5c0c-442c-9429-916003d36597
2012-10-18 11:09:34 +00:00
parent 5a2c848369
commit fcd018e85a
1 changed files with 3 additions and 1 deletions
--- a/src/OpenMesh/Core/IO/reader/BaseReader.hh
+++ b/src/OpenMesh/Core/IO/reader/BaseReader.hh
@@ -114,7 +114,9 @@ public:
 		
 /** Reads a mesh given by a std::stream. This method usually uses the same stream reading method
    that read uses. Options can be passed via _opt. After execution _opt contains the Options
-      that were available
+      that were available.
+
+      Please make sure that if _is is std::ifstream, the correct std::ios_base::openmode flags are set. 
  */
  virtual bool read(std::istream& _is, 
 		    BaseImporter& _bi,