Changeset da09909 for molecuilder/src/Views/StreamStringView.hpp

Timestamp:

Dec 16, 2009, 2:40:09 PM (16 years ago)

Author:

Tillmann Crueger <crueger@…>

Children:

38546d

Parents:

c2c893

Message:

Improved documentation for menu framework.

File:

• molecuilder/src/Views/StreamStringView.hpp (modified) (1 diff)

molecuilder/src/Views/StreamStringView.hpp

@@ -13 +13 @@
 #include "Views/StringView.hpp"
 
+/**
+ * Wrapper to produce a StringView from any method that uses a stream to display something.
+ *
+ * The function is called with a stringstream which then is turned into a string later.
+ *
+ * Caveat: Make sure the stream passed to the method is actually used. Some methods seem to use a stream parameter for
+ * legacy reasons. These methods internally use the "Log() << Verbose()" mechanism instead of the stream.
+ */
 class StreamStringView : public StringView
 {