Documentation fixes

Dead code removal
wrench-project · Nov 27, 2017 · f14c24b · f14c24b
1 parent 164002d
commit f14c24b
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 14 deletions.
diff --git a/include/wrench/services/compute/batch/BatchScheduler.h b/include/wrench/services/compute/batch/BatchScheduler.h
@@ -10,9 +10,14 @@
 #include "BatchService.h"
 
 namespace wrench {
+
     /***********************/
     /** \cond INTERNAL     */
     /***********************/
+
+    /**
+     * @brief An implementation of a batch scheduling algorithm to be used in a BatchService
+     */
     class BatchScheduler {
     public:
         BatchScheduler();

diff --git a/include/wrench/services/compute/standard_job_executor/StandardJobExecutorProperty.h b/include/wrench/services/compute/standard_job_executor/StandardJobExecutorProperty.h
@@ -19,6 +19,9 @@ namespace wrench {
     /** \cond INTERNAL     */
     /***********************/
 
+    /**
+     * @brief Properties for a StandardJobExecutor
+     */
     class StandardJobExecutorProperty {
 
     public:

diff --git a/include/wrench/services/helpers/Alarm.h b/include/wrench/services/helpers/Alarm.h
@@ -24,6 +24,10 @@ namespace wrench {
     /** \cond INTERNAL     */
     /***********************/
 
+    /**
+     * @brief A daemon that sends a message to a mailbox after some specified amount of time and then terminates
+     */
+
     class Alarm: public Service {
 
         friend class S4U_Daemon;

diff --git a/include/wrench/util/PointerUtil.h b/include/wrench/util/PointerUtil.h
@@ -21,10 +21,20 @@ namespace wrench {
     /** \cond INTERNAL     */
     /***********************/
 
+    /**
+     * @brief A helper class that implements useful smart pointer operations
+     */
     class PointerUtil {
 
     public:
 
+        /**
+         * @brief A helper method to move a unique_ptr from a set to another
+         * @tparam T: template class
+         * @param ptr: unique pointer to an object of class T that's in a set
+         * @param from: pointer to the set in which the object is
+         * @param to: pointer to the set to which the object should be moved
+         */
         template<class T>
         static void moveUniquePtrFromSetToSet(
                 typename std::set<std::unique_ptr<T>>::iterator it,

diff --git a/src/wrench/services/compute/batch/BatchScheduler.cpp b/src/wrench/services/compute/batch/BatchScheduler.cpp
@@ -5,9 +5,18 @@
 #include "wrench/services/compute/batch/BatchScheduler.h"
 
 namespace wrench{
+
+    /**
+     * @brief Constructor
+     */
     BatchScheduler::BatchScheduler() {
 
     }
+
+    /**
+     * @brief Schedule method
+     * @return
+     */
     BatchJob* BatchScheduler::schedule_job() {
         //We currently only support FCFS
 //        if(BatchService::);

diff --git a/src/wrench/services/helpers/Alarm.cpp b/src/wrench/services/helpers/Alarm.cpp
@@ -21,6 +21,14 @@ namespace wrench {
         WRENCH_INFO("Alarm::~Alarm()::In the destructor of Alarm");
     }
 
+    /**
+     * @brief Constructor
+     * @param date: the date at this the message should be sent
+     * @param hostname: the name of the host on which the Alarm daemon should run
+     * @param reply_mailbox_name: the mailbox to which the message should be sent
+     * @param msg: the message to send
+     * @param suffix: a (possibly empty) suffix to append to the daemon name
+     */
     Alarm::Alarm(double date, std::string hostname, std::string reply_mailbox_name,
                  SimulationMessage* msg, std::string suffix):Service("alarm_service_"+suffix,"alarm_service_"+suffix) {
 
@@ -40,6 +48,11 @@ namespace wrench {
         }
     }
 
+    /**
+     * @brief Main method of the daemon
+     *
+     * @return 0 on termination
+     */
     int Alarm::main() {
         TerminalOutput::setThisProcessLoggingColor(WRENCH_LOGGING_COLOR_MAGENTA);
         WRENCH_INFO("Alarm Service starting on host %s!", S4U_Simulation::getHostName().c_str());
@@ -61,6 +74,10 @@ namespace wrench {
         return 0;
     }
 
+    /**
+     * @brief Brutally kill the daemon
+     *
+     */
     void Alarm::kill() {
         //kill itself
         this->kill_actor();

diff --git a/src/wrench/util/PointerUtil.cpp b/src/wrench/util/PointerUtil.cpp
@@ -17,18 +17,14 @@ namespace wrench {
     /** \cond INTERNAL    */
     /***********************/
 
-//    template <class T>
-//    void PointerUtil::moveUniquePtrFromSetToSet(
-//                          typename std::set<std::unique_ptr<T>>::iterator it,
-//                          std::set<std::unique_ptr<T>> *from,
-//                          std::set<std::unique_ptr<T>> *to) {
-//
-//      auto tmp = const_cast<std::unique_ptr<T>&&>(*it);
-//      (*from).erase(it);
-//      (*to).insert(std::move(tmp));
-//
-//    }
 
+    /**
+     * @brief An internal helper method to move a unique_ptr from a set to another
+     * @tparam T: template class
+     * @param ptr: unique pointer to an object of class T that's in a set
+     * @param from: pointer to the set in which the object is
+     * @param to: pointer to the set to which the object should be moved
+     */
     template <class T>
     void PointerUtil::moveSingleSeparateUniquePtrFromSetToSet(std::unique_ptr<T>* ptr,
                                                        std::set<std::unique_ptr<T>> *from,
@@ -38,9 +34,6 @@ namespace wrench {
       (*to).insert(std::move(tmp));
     };
 
-    template void PointerUtil::moveSingleSeparateUniquePtrFromSetToSet<StandardJobExecutor>(std::unique_ptr<StandardJobExecutor> *ptr,
-                                                                      std::set<std::unique_ptr<StandardJobExecutor>> *from,
-                                                                      std::set<std::unique_ptr<StandardJobExecutor>> *to);
 
     /***********************/
     /** \endcond           */