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

diff --git a/source/strings/format.h b/source/strings/format.h
index db74bf9..6d8f739 100644
--- a/source/strings/format.h
+++ b/source/strings/format.h
@@ -1,10 +1,3 @@
-/* $Id$
-
-This file is part of libmspstrings
-Copyright © 2006-2007 Mikko Rasa
-Distributed under the LGPL
-*/
-
 #ifndef MSP_STRINGS_FORMAT_H_
 #define MSP_STRINGS_FORMAT_H_
 
@@ -36,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();
 };