Changeset da09909 for molecuilder/src/Views

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.

Location:

molecuilder/src/Views

Files:

• MethodStringView.hpp (modified) (1 diff)
• StreamStringView.hpp (modified) (1 diff)
• StringView.hpp (modified) (1 diff)
• View.hpp (modified) (1 diff)

molecuilder/src/Views/MethodStringView.hpp

@@ -13 +13 @@
 #include "Views/StringView.hpp"
 
+/**
+ * Wrapper to produce a StringView from any method that returns a String.
+ */
 class MethodStringView : public StringView
 {

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
 {

molecuilder/src/Views/StringView.hpp

@@ -14 +14 @@
 using namespace std;
 
+/**
+ * View to show something as a string
+ *
+ * This View is used by calling the toString method.
+ * This View does *not* use the observer pattern.
+ */
 class StringView : public View
 {

molecuilder/src/Views/View.hpp

@@ -9 +9 @@
 #define VIEW_H_
 
+/**
+ * Base class for all Views
+ *
+ * TODO: is this really needed or helpfull at all?
+ */
 class View
 {