From bee287603e812ca70a3b726d98d72ba441b366a1 Mon Sep 17 00:00:00 2001 From: ponchio Date: Mon, 21 Mar 2011 17:20:38 +0000 Subject: [PATCH] added minimal doc on Open. --- wrap/io_trimesh/import.h | 4 ++-- wrap/io_trimesh/import_ply.h | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/wrap/io_trimesh/import.h b/wrap/io_trimesh/import.h index b362b041..872530dc 100644 --- a/wrap/io_trimesh/import.h +++ b/wrap/io_trimesh/import.h @@ -103,14 +103,14 @@ static bool FileExtension(std::string filename, std::string extension) return end==extension; } -// Open Mesh +// Open Mesh, returns 0 on success. static int Open(OpenMeshType &m, const char *filename, CallBackPos *cb=0) { int dummymask = 0; 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) { int err; diff --git a/wrap/io_trimesh/import_ply.h b/wrap/io_trimesh/import_ply.h index 249a4178..fe52e239 100644 --- a/wrap/io_trimesh/import_ply.h +++ b/wrap/io_trimesh/import_ply.h @@ -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) { 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 ) { assert(filename!=0);