From d370b6e06cc7431846285f973752f8b617eb82d3 Mon Sep 17 00:00:00 2001 From: Isaak Lim Date: Mon, 15 Oct 2012 10:42:13 +0000 Subject: [PATCH] - added some documentation to the BaseWriter git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@747 fdac6126-5c0c-442c-9429-916003d36597 --- src/OpenMesh/Core/IO/writer/BaseWriter.hh | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/OpenMesh/Core/IO/writer/BaseWriter.hh b/src/OpenMesh/Core/IO/writer/BaseWriter.hh index cb78e8cb..a0d31720 100644 --- a/src/OpenMesh/Core/IO/writer/BaseWriter.hh +++ b/src/OpenMesh/Core/IO/writer/BaseWriter.hh @@ -96,13 +96,23 @@ public: /// Returns true if writer can parse _filename (checks extension) virtual bool can_u_write(const std::string& _filename) const; - /// Write to file _filename. Data source specified by BaseExporter _be. + /** Write to a file + * @param _filename write to file with the given filename + * @param _be BaseExporter, which specifies the data source + * @param _opt writing options + * @param _precision can be used to specify the precision of the floating point notation. + */ virtual bool write(const std::string& _filename, BaseExporter& _be, Options _opt, std::streamsize _precision = 6) const = 0; - /// Write to std::ostream _os. Data source specified by BaseExporter _be. + /** Write to a std::ostream + * @param _os write to std::ostream + * @param _be BaseExporter, which specifies the data source + * @param _opt writing options + * @param _precision can be used to specify the precision of the floating point notation. + */ virtual bool write(std::ostream& _os, BaseExporter& _be, Options _opt,