added minimal doc on Open.

This commit is contained in:
Federico Ponchio 2011-03-21 17:20:38 +00:00
parent e3d8489f0f
commit bee287603e
2 changed files with 4 additions and 4 deletions

View File

@ -103,14 +103,14 @@ static bool FileExtension(std::string filename, std::string extension)
return end==extension; return end==extension;
} }
// Open Mesh // Open Mesh, returns 0 on success.
static int Open(OpenMeshType &m, const char *filename, CallBackPos *cb=0) static int Open(OpenMeshType &m, const char *filename, CallBackPos *cb=0)
{ {
int dummymask = 0; int dummymask = 0;
return Open(m,filename,dummymask,cb); return Open(m,filename,dummymask,cb);
} }
// Open Mesh and return the load mask (the load mask must be initialized first) /// Open Mesh and fills the load mask (the load mask must be initialized first); returns 0 on success.
static int Open(OpenMeshType &m, const char *filename, int &loadmask, CallBackPos *cb=0) static int Open(OpenMeshType &m, const char *filename, int &loadmask, CallBackPos *cb=0)
{ {
int err; int err;

View File

@ -431,7 +431,7 @@ static bool ErrorCritical(int err)
} }
/// Standard call for reading a mesh /// Standard call for reading a mesh, returns 0 on success.
static int Open( OpenMeshType &m, const char * filename, CallBackPos *cb=0) static int Open( OpenMeshType &m, const char * filename, CallBackPos *cb=0)
{ {
PlyInfo pi; PlyInfo pi;
@ -453,7 +453,7 @@ static int Open( OpenMeshType &m, const char * filename, int & loadmask, CallBac
} }
/// read a mesh with all the possible option specified in the PlyInfo obj. /// read a mesh with all the possible option specified in the PlyInfo obj, returns 0 on success.
static int Open( OpenMeshType &m, const char * filename, PlyInfo &pi ) static int Open( OpenMeshType &m, const char * filename, PlyInfo &pi )
{ {
assert(filename!=0); assert(filename!=0);