X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Fstrings%2Fformat.h;h=6d8f739a436c3abaa8fdbbbdc7292e5dfb803d1d;hb=1f0843257065789231a9949e0a81b79afd7bbebe;hp=9264b10bad1ec2b2f951065d3ee1562d8f033d27;hpb=967785734be5c3fc6f75da122c2d93ebbb338271;p=libs%2Fcore.git

diff --git a/source/strings/format.h b/source/strings/format.h
index 9264b10..6d8f739 100644
--- a/source/strings/format.h
+++ b/source/strings/format.h
@@ -29,9 +29,18 @@ public:
 		return *this;
 	}
 
+	/** Returns the result of the formatting operation.  Will throw if not
+	enough values have been fed to the formatter. */
 	const std::string &str() const;
+
 private:
+	/** Advances the iterator to the next conversion, adding literal characters
+	to the result.  The iterator is left at the second character of the
+	conversion (i.e. after the %). */
 	void advance();
+
+	/** Reads the next conversion from the format string and returns a
+	corresponding Fmt object. */
 	Fmt get_conversion();
 };