- added doxygen documentation

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

src/backend/pyloader/python_policy.hh

@@ -36,24 +36,52 @@ namespace sgpem
   class PythonPolicy;
   class PythonPolicyManager;
   class UserInterruptException;
-	
+
+	/** \brief A specialization of abstract class Policy
+
+		This class represents a policy written in Python. Its methods interact with Python interpreter.
+		See the documentation of class Policy for more detailed informations.
+	*/
   class SG_DLLEXPORT PythonPolicy : public Policy
   {
-  public:  
+  public:
     //only PythonPolicyManager can create a PythonPolicy object
     friend class PythonPolicyManager;
-	
+
     virtual ~PythonPolicy();
-	
+
+	/**
+		Calls the method \c async_configure
+	*/
     void			configure() throw(UserInterruptException);
+
+    /**
+    	Calls the method \c async_sort_queue
+    */
     void 			sort_queue(Scheduler::event) const throw(UserInterruptException);
+
+    /**
+    	\returns A textual description of this policy.
+    */
     Glib::ustring 	        get_description() const;
+
+    /**
+    	\returns \c TRUE if the policy is preemptive.
+    	\returns \c FALSE if the policy is not preemptive.
+    */
     bool 			is_pre_emptive() const throw(UserInterruptException);
-    int                         get_time_slice() const throw(UserInterruptException);
+
+    /**
+    	\returns The integer value of its time-slice.
+    */
+    int              get_time_slice() const throw(UserInterruptException);
 
     // Singing with Caipha's voice: "must die, must die, this method must die!"
+    /**
+    	Changes the time-slice of the policy.
+    */
     void 			set_time_slice(const int&);
-    			
+
   private:
     PythonPolicy(const char* name);
     PythonPolicy(const PythonPolicy&);