internals: a few docu fixes/additions

Author: torbjoernk

include/pfasst/interfaces.hpp

@@ -33,10 +33,6 @@ namespace pfasst
        * @param[in] msg component or algorithm the throwing function is required for
        */
       explicit NotImplementedYet(const string& msg);
-
-      /**
-       * message string is prepended by the string `Not implemented/supported yet, required for: `
-       */
       virtual const char* what() const throw();
   };
 
@@ -54,10 +50,6 @@ namespace pfasst
 
     public:
       explicit ValueError(const string& msg);
-
-      /**
-       * message string is prepended by the string `ValueError: `
-       */
       virtual const char* what() const throw();
   };
 
@@ -121,9 +113,9 @@ namespace pfasst
       /**
        * set the sweepers controller.
        */
-      void set_controller(Controller<time>* ctrl);
+      virtual void set_controller(Controller<time>* ctrl);
 
-      Controller<time>* get_controller();
+      virtual Controller<time>* get_controller();
       //! @}
 
       //! @{

include/pfasst/interfaces_impl.hpp

@@ -14,6 +14,10 @@ namespace pfasst
     : runtime_error(msg)
   {}
 
+  /**
+   * @internal message string is prepended by the string
+   *   `Not implemented/supported yet, required for: `
+   */
   const char* NotImplementedYet::what() const throw()
   {
     return (string("Not implemented/supported yet, required for: ") + this->msg).c_str();
@@ -24,6 +28,9 @@ namespace pfasst
     : invalid_argument(msg)
   {}
 
+  /**
+   * @internal message string is prepended by the string `ValueError: `
+   */
   const char* ValueError::what() const throw()
   {
     return (string("ValueError: ") + this->msg).c_str();
@@ -50,6 +57,12 @@ namespace pfasst
     return !this->get_converged(this->comm->rank()-1);
   }
 
+  /**
+   * @internal Returning logic depends on current process' rank.
+   *   In case it is not the master process, both the converged state of this and the previous rank
+   *   are checked.
+   * @see `IStatus::get_converged()`
+   */
   bool IStatus::keep_iterating()
   {
     if (this->comm->rank() == 0) {
@@ -74,6 +87,11 @@ namespace pfasst
     this->controller = ctrl;
   }
 
+  /**
+   * @internal
+   * @note Asserts presense of a controller if `NDEBUG` is not defined.
+   * @endinternal
+   */
   template<typename time>
   Controller<time>* ISweeper<time>::get_controller()
   {
@@ -97,13 +115,19 @@ namespace pfasst
     return false;
   }
 
+  /**
+   * @throws NotImplementedYet This function is required by MLSDC and PFASST
+   */
   template<typename time>
   void ISweeper<time>::save(bool initial_only)
   {
     UNUSED(initial_only);
     throw NotImplementedYet("mlsdc/pfasst");
   }
 
+  /**
+   * @throws NotImplementedYet This function is required by PFASST
+   */
   template<typename time>
   void ISweeper<time>::spread()
   {
@@ -126,22 +150,31 @@ namespace pfasst
   void ISweeper<time>::post(ICommunicator* comm, int tag)
   {
     UNUSED(comm); UNUSED(tag);
-  };
+  }
 
+  /**
+   * @throws NotImplementedYet This function is required by PFASST
+   */
   template<typename time>
   void ISweeper<time>::send(ICommunicator* comm, int tag, bool blocking)
   {
     UNUSED(comm); UNUSED(tag); UNUSED(blocking);
     throw NotImplementedYet("pfasst");
   }
 
+  /**
+   * @throws NotImplementedYet This function is required by PFASST
+   */
   template<typename time>
   void ISweeper<time>::recv(ICommunicator* comm, int tag, bool blocking)
   {
     UNUSED(comm); UNUSED(tag); UNUSED(blocking);
     throw NotImplementedYet("pfasst");
   }
 
+  /**
+   * @throws NotImplementedYet This function is required by PFASST
+   */
   template<typename time>
   void ISweeper<time>::broadcast(ICommunicator* comm)
   {
@@ -154,18 +187,25 @@ namespace pfasst
   ITransfer<time>::~ITransfer()
   {}
 
+  /**
+   * @throws NotImplementedYet This function is required by PFASST
+   */
   template<typename time>
-  void ITransfer<time>::interpolate_initial(shared_ptr<ISweeper<time>> dst, shared_ptr<const ISweeper<time>> src)
+  void ITransfer<time>::interpolate_initial(shared_ptr<ISweeper<time>> dst,
+                                            shared_ptr<const ISweeper<time>> src)
   {
     UNUSED(dst); UNUSED(src);
     throw NotImplementedYet("pfasst");
   }
 
+  /**
+   * @throws NotImplementedYet This function is required by PFASST
+   */
   template<typename time>
-  void ITransfer<time>::restrict_initial(shared_ptr<ISweeper<time>> dst, shared_ptr<const ISweeper<time>> src)
+  void ITransfer<time>::restrict_initial(shared_ptr<ISweeper<time>> dst,
+                                         shared_ptr<const ISweeper<time>> src)
   {
     UNUSED(dst); UNUSED(src);
     throw NotImplementedYet("pfasst");
   }
-
 }  // ::pfasst