Added comments for documentation

This commit is contained in:
Paolo Cignoni 2006-11-21 19:23:50 +00:00
parent 83bd514579
commit c7909c67f1
4 changed files with 33 additions and 10 deletions

View File

@ -20,6 +20,11 @@
* for more details. *
* *
****************************************************************************/
/****************************************************************************
History
$Log: not supported by cvs2svn $
****************************************************************************/
#ifndef __VCGLIB_EXPORT_DXF
#define __VCGLIB_EXPORT_DXF
@ -28,14 +33,14 @@ namespace tri {
namespace io {
template <class SaveMeshType>
/**
This class encapsulate a filter for save dxf meshes.
*/
class ExporterDXF
{
public:
/*
Prima versione da rivedere e ottimizzare, ma compatibile con Autocad.
*/
static int Save(SaveMeshType &m, const char * filename)
///Standard call for saving a mesh
static int Save(SaveMeshType &m, const char * filename)
{
FILE * o = fopen(filename,"w");
@ -79,7 +84,7 @@ public:
fclose(o);
return 0;
}
/// Standard call for knowing the meaning of an error code
static const char *ErrorMsg(int error)
{
static std::vector<std::string> dxf_error_msg;

View File

@ -23,6 +23,7 @@
/****************************************************************************
History
$Log: not supported by cvs2svn $
Revision 1.2 2006/11/16 11:24:44
****************************************************************************/
#ifndef __VCGLIB_EXPORT_SMF
@ -35,6 +36,9 @@ namespace tri {
namespace io {
template <class SaveMeshType>
/**
This class encapsulate a filter for save smf meshes.
*/
class ExporterSMF
{
public:
@ -45,6 +49,7 @@ namespace io {
typedef typename SaveMeshType::VertexIterator VertexIterator;
typedef typename SaveMeshType::FaceIterator FaceIterator;
///Standard call for saving a mesh
static int Save(SaveMeshType &m, const char * filename, const int &mask, CallBackPos *cb=0)
{
VertexIterator vi;
@ -75,6 +80,8 @@ namespace io {
fclose(fp);
return 0;
}
/// Standard call for knowing the meaning of an error code
static const char *ErrorMsg(int error)
{
static std::vector<std::string> smf_error_msg;

View File

@ -20,6 +20,11 @@
* for more details. *
* *
****************************************************************************/
/****************************************************************************
History
$Log: not supported by cvs2svn $
****************************************************************************/
#ifndef __VCGLIB_IMPORT_PTX
#define __VCGLIB_IMPORT_PTX
@ -69,7 +74,8 @@ namespace vcg {
int fn;
RANGEMAP_INFO_TABLE rmapInfo;
};
/// Standard call for knowing the meaning of an error code
static const char *ErrorMsg(int error)
{
static const char * ptx_error_msg[] =
@ -84,6 +90,7 @@ namespace vcg {
if(error>6 || error<0) return "Unknown error";
else return ptx_error_msg[error];
};
static bool skipmesh(FILE* fp, CallBackPos *cb=NULL)
{
PTX_HEAD_INFO tab;
@ -537,7 +544,7 @@ namespace vcg {
}
///Call that load a mesh
static bool readPTX( OpenMeshType &m, FILE *fp, int mask, CallBackPos *cb=NULL)
{
int numtokens;
@ -755,7 +762,7 @@ namespace vcg {
return true;
}
//The Open function called from meshio.cpp
///Standard call that reading a mesh
static int Open( OpenMeshType &m, const char * filename, int mask = PTX_ONLY_POINTS, CallBackPos *cb=NULL)
{
FILE *fp;

View File

@ -23,7 +23,6 @@
/****************************************************************************
History
$Log: not supported by cvs2svn $
****************************************************************************/
#ifndef __VCGLIB_IMPORTER_SMF
@ -36,6 +35,9 @@ namespace vcg {
namespace tri {
namespace io {
template<class OpenMeshType>
/**
This class encapsulate a filter for opening smf meshes.
*/
class ImporterSMF
{
public:
@ -63,6 +65,7 @@ namespace io {
E_UNESPECTEDEOF // 2
};
/// Standard call for knowing the meaning of an error code
static const char *ErrorMsg(int error)
{
static const char * smf_error_msg[] =
@ -74,6 +77,7 @@ namespace io {
if(error>2 || error<0) return "Unknown error";
else return smf_error_msg[error];
};
///Standard call for reading a mesh
static int Open(OpenMeshType &m, const char * filename )
{
VertexType v;