doc: fix formatting

include/amici/amici.h

@@ -41,6 +41,7 @@ std::vector<std::unique_ptr<ReturnData>> run_simulations(
 /**
  * @brief Get the string representation of the given simulation status code
  * (see ReturnData::status).
+ *
  * @param status Status code
  * @return Name of the variable representing this status code.
  */

include/amici/cblas.h

@@ -62,6 +62,7 @@ void amici_dgemm(
 
 /**
  * @brief Compute y = a*x + y
+ *
  * @param n         number of elements in y
  * @param alpha     scalar coefficient of x
  * @param x         vector of length n*incx

include/amici/edata.h

@@ -471,6 +471,7 @@ class ExpData : public SimulationParameters {
 
 /**
  * @brief Equality operator
+ *
  * @param lhs some object
  * @param rhs another object
  * @return `true`, if both arguments are equal; `false` otherwise.
@@ -541,6 +542,7 @@ class ConditionContext : public ContextManager {
 
     /**
      * @brief Restore original settings on constructor-supplied amici::Model.
+     *
      * Will be called during destruction. Explicit call is generally not
      * necessary.
      */

include/amici/event.h

@@ -29,6 +29,7 @@ class Event {
   public:
     /**
      * @brief Event constructor
+     *
      * @param id ID of the event
      * @param use_values_from_trigger_time Whether the event assignment is
      * evaluated using the state from the time point at which the event
@@ -48,18 +49,21 @@ class Event {
 
     /**
      * @brief Get the ID of the event
+     *
      * @return The ID of the event.
      */
     std::string const& get_id() const { return id_; }
 
     /**
      * @brief Get the initial value of the root function
+     *
      * @return The value of the root function at t_0.
      */
     bool get_initial_value() const { return initial_value_; }
 
     /**
      * @brief Get the priority of the event assignments
+     *
      * @return The priority of the event assignments, or NAN if undefined.
      */
     realtype get_priority() const { return priority_; }
@@ -138,18 +142,21 @@ class EventQueue {
 
     /**
      * @brief Check if the queue is empty
+     *
      * @return True if the queue is empty, false otherwise
      */
     bool empty() const { return pending_events_.empty(); }
 
     /**
      * @brief Push an event to the queue
+     *
      * @param event The event to push
      */
     void push(PendingEvent event) { pending_events_.push_back(event); }
 
     /**
      * @brief Get the next event to handle and remove it from the queue
+     *
      * @return The next event to handle
      * @throws std::runtime_error if there are no pending events
      */
@@ -167,7 +174,7 @@ class EventQueue {
         });
 
         // If there is any undefined (NaN) priority, the order of all
-        // simulataneously executed events is undefined. We just proceed
+        // simultaneously executed events is undefined. We just proceed
         // with the first one in the list.
         if (std::any_of(
                 pending_events_.begin(), pending_events_.end(),

include/amici/exception.h

@@ -127,12 +127,13 @@ class IntegrationFailureB : public AmiException {
   public:
     /**
      * @brief Constructor
-     * @param code error code returned by cvode/ida
+     *
+     * @param code error code returned by CVODES/IDAS
      * @param t time of integration failure
      */
     IntegrationFailureB(int code, realtype t);
 
-    /** error code returned by cvode/ida */
+    /** error code returned by CVODES/IDAS */
     int error_code;
 
     /** time of integration failure */
@@ -150,6 +151,7 @@ class SetupFailure : public AmiException {
   public:
     /**
      * @brief Constructor with printf style interface
+     *
      * @param fmt error message with printf format
      * @param ... printf formatting variables
      */
@@ -167,6 +169,7 @@ class NewtonFailure : public AmiException {
   public:
     /**
      * @brief Constructor, simply calls AmiException constructor
+     *
      * @param function name of the function in which the error occurred
      * @param code error code
      */