X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;ds=sidebyside;f=source%2Fwriter.h;h=698bade8f650cf45198ee92ac147f18a10540b02;hb=505042fcda16151f5ace243c243d34af3efcf677;hp=756e19a22c41668cea43fb5387944b90b84a4721;hpb=27630d44298cb67e075c166f4421288cc8ca117e;p=libs%2Fdatafile.git

diff --git a/source/writer.h b/source/writer.h
index 756e19a..698bade 100644
--- a/source/writer.h
+++ b/source/writer.h
@@ -18,6 +18,9 @@ namespace DataFile {
 class Statement;
 class WriterMode;
 
+/**
+Frontend for writing data.
+*/
 class Writer
 {
 private:
@@ -26,9 +29,21 @@ private:
 	bool binary;
 
 public:
-	Writer(std::ostream &);
-	void write(const Statement &);
-	void set_binary(bool);
+	Writer(std::ostream &o);
+
+	/**
+	Writes a statement to the output.  This function always writes a complete
+	statement, so it's not possible to add substatements later.
+	*/
+	void write(const Statement &st);
+
+	/**
+	Sets binary or text mode.  While it is possible to enter and exit binary
+	mode multiple times, doing so produces sub-optimal output.
+
+	@param  b  true for binary mode, false for text
+	*/
+	void set_binary(bool b);
 };
 
 } // namespace DataFile