- More documentation

git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@437 3ecf2c5c-341e-0410-92b4-d18e462d057c

src/backend/dummy_policy.cc

@@ -19,6 +19,7 @@
 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 #include "dummy_policy.hh"
+
 using namespace std;
 using namespace sgpem;
 
@@ -42,7 +43,7 @@ DummyPolicy::configure()
 Glib::ustring
 DummyPolicy::get_description() const
 {
-	return "Questa è una STUPIDISSIMA politica implementata in C++. Serve solo per debug.";
+	return "This is a dummy policy implemented in C++. It is just needed as a debug stub.";
 }
 
 bool

src/backend/dummy_policy.hh

@@ -29,14 +29,18 @@
 
 namespace sgpem
 {
-
   class DummyPolicy;
 
+  /** \brief This is a trivial policy for demostration purposes only
+   *
+   * This trivial schedulation policy was needed during initial development
+   * as stub. It is now maintained as an example of how built-in policy can
+   * be implemented in C++.
+   */
   class SG_DLLEXPORT DummyPolicy : public Policy
   {
   public:
     virtual ~DummyPolicy();
-				
     virtual void configure();
     virtual void sort_queue(sgpem::Scheduler::event) const;
     virtual Glib::ustring get_description() const;
@@ -47,7 +51,6 @@ namespace sgpem
   private:
     int _time_slice;
   };
-	
 } //~ namespace sgpem
 
-#endif
+#endif // DUMMYPOLICY_HH