Fix doxygen

include/cpp_common/get_check_data.hpp

@@ -99,8 +99,6 @@ spi_getMaxTasks(
     TupleDesc *tupdesc,
     Column_info_t info);
 
-/** @name timestamp related
- * @{ */
 /** @brief  Converts timestamp to timestamp without timezone */
 TTimestamp timestamp_without_timezone(TTimestamp timestamp);
 
@@ -115,10 +113,7 @@ TTimestamp get_TTimestamp_plain(HeapTuple*, TupleDesc*, Column_info_t, TTimestam
 
 /** @brief gets a timestamp value from ANY-INTEGER > 0 */
 TTimestamp get_PositiveTTimestamp_plain(HeapTuple*, TupleDesc*, Column_info_t, TTimestamp);
-/* @} */
 
-/** @name interval related
- * @{ */
 /** @brief gets an interval value from postgres type INTERVAL */
 TInterval get_TInterval(HeapTuple*, TupleDesc*, Column_info_t, TInterval);
 
@@ -130,7 +125,6 @@ TInterval get_TInterval_plain(HeapTuple*, TupleDesc*, Column_info_t, TInterval);
 
 /** @brief gets an interval value from ANY-INTEGER > 0 */
 TInterval get_PositiveTInterval_plain(HeapTuple*, TupleDesc*, Column_info_t, TInterval);
-/* @} */
 
 /** get Id from data */
 Id get_Id(HeapTuple*, TupleDesc*, Column_info_t, Id);

include/drivers/compatibleVehicles_driver.h

@@ -49,21 +49,17 @@ typedef struct CompatibleVehicles_rt CompatibleVehicles_rt;
 extern "C" {
 #endif
 
-    /** @brief Driver for processing a "compatible vehicles" problem */
-  void do_compatibleVehicles(
-      Orders_t customers_arr[], size_t total_customers,
-      Vehicle_t *vehicles_arr,              size_t total_vehicles,
-      Matrix_cell_t *matrix_cells_arr,      size_t total_cells,
-      Time_multipliers_t *multipliers_arr,               size_t total_multipliers,
+/** @brief Driver for processing a "compatible vehicles" problem */
+void vrp_do_compatibleVehicles(
+        Orders_t customers_arr[], size_t total_customers,
+        Vehicle_t *vehicles_arr,              size_t total_vehicles,
+        Matrix_cell_t *matrix_cells_arr,      size_t total_cells,
+        Time_multipliers_t *multipliers_arr,               size_t total_multipliers,
 
-      double factor,
+        double,
 
-      CompatibleVehicles_rt **return_tuples,
-      size_t *return_count,
-
-      char **log_msg,
-      char **notice_msg,
-      char **err_msg);
+        CompatibleVehicles_rt **, size_t*,
+        char**, char**, char**);
 
 
 #ifdef __cplusplus

include/drivers/optimize_driver.h

@@ -38,25 +38,15 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 extern "C" {
 #endif
 
-    /** @brief Driver for processing a pickupDeliver problem */
-    void do_optimize(
-            Orders_t customers_arr[], size_t,
-            Vehicle_t *vehicles_arr, size_t,
-            Matrix_cell_t *, size_t,
-            Time_multipliers_t *, size_t,
-
-            double,
-            int,
-            int64_t,
-
-            bool, bool, bool,
-
-            Short_vehicle_rt**,
-            size_t*,
-
-            char**,
-            char**,
-            char**);
+void vrp_do_optimize(
+        Orders_t customers_arr[], size_t,
+        Vehicle_t *vehicles_arr, size_t,
+        Matrix_cell_t *, size_t,
+        Time_multipliers_t *, size_t,
+        double, int, int64_t, bool, bool, bool,
+
+        Short_vehicle_rt**, size_t*,
+        char**, char**, char**);
 
 
 #ifdef __cplusplus

include/drivers/pgr_pickDeliverEuclidean_driver.h

@@ -26,8 +26,6 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
  ********************************************************************PGR-GNU*/
 
-/*! @file pickDeliverEuclidean_driver.h */
-
 #ifndef INCLUDE_DRIVERS_PGR_PICKDELIVEREUCLIDEAN_DRIVER_H_
 #define INCLUDE_DRIVERS_PGR_PICKDELIVEREUCLIDEAN_DRIVER_H_
 #pragma once
@@ -47,26 +45,13 @@ typedef struct Vehicle_t Vehicle_t;
 extern "C" {
 #endif
 
-  /*********************************************************
-    orders_sql TEXT,
-    max_vehicles INTEGER,
-    capacity FLOAT,
-    max_cycles INTEGER,
-   ********************************************************/
-  void do_pgr_pickDeliverEuclidean(
-      Orders_t *pd_orders_arr, size_t total_pd_orders,
-      Vehicle_t *vehicles_arr, size_t total_vehicles,
-
-      double factor,
-      int max_cycles,
-      int initial_solution_id,
-
-      Solution_rt **return_tuples,
-      size_t *return_count,
-
-      char **log_msg,
-      char **notice_msg,
-      char **err_msg);
+void vrp_do_pgr_pickDeliverEuclidean(
+        Orders_t *pd_orders_arr, size_t total_pd_orders,
+        Vehicle_t *vehicles_arr, size_t total_vehicles,
+        double, int, int,
+
+        Solution_rt**, size_t*,
+        char**, char**, char**);
 
 
 #ifdef __cplusplus

include/drivers/pgr_pickDeliver_driver.h

@@ -49,27 +49,14 @@ typedef struct Solution_rt Solution_rt;
 extern "C" {
 #endif
 
-  /*********************************************************
-    orders_sql TEXT,
-    max_vehicles INTEGER,
-    capacity FLOAT,
-    max_cycles INTEGER,
-   ********************************************************/
-  void do_pgr_pickDeliver(
-      Orders_t *pd_orders_arr, size_t total_pd_orders,
-      Vehicle_t *vehicles_arr, size_t total_vehicles,
-      Matrix_cell_t *matrix_cells_arr, size_t total_cells,
-
-      double factor,
-      int max_cycles,
-      int initial_solution_id,
-
-      Solution_rt **return_tuples,
-      size_t *return_count,
-
-      char **log_msg,
-      char **notice_msg,
-      char **err_msg);
+void vrp_do_pgr_pickDeliver(
+        Orders_t *pd_orders_arr, size_t total_pd_orders,
+        Vehicle_t *vehicles_arr, size_t total_vehicles,
+        Matrix_cell_t *matrix_cells_arr, size_t total_cells,
+        double, int, int,
+
+        Solution_rt**, size_t*,
+        char**, char**, char**);
 
 
 #ifdef __cplusplus

include/drivers/pickDeliver_driver.h

@@ -38,25 +38,15 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 extern "C" {
 #endif
 
-  /** @brief Driver for processing a pickupDeliver problem */
-  void do_pickDeliver(
-      Orders_t customers_arr[], size_t total_customers,
-      Vehicle_t *vehicles_arr, size_t total_vehicles,
-      Matrix_cell_t *matrix_cells_arr, size_t total_cells,
-      Time_multipliers_t *multipliers_arr, size_t total_multipliers,
-
-      bool,
-      double factor,
-      int max_cycles,
-      bool stop_on_all_served,
-      int64_t execution_date,
-
-      Solution_rt **return_tuples,
-      size_t *return_count,
-
-      char **log_msg,
-      char **notice_msg,
-      char **err_msg);
+void vrp_do_pickDeliver(
+        Orders_t customers_arr[], size_t total_customers,
+        Vehicle_t *vehicles_arr, size_t total_vehicles,
+        Matrix_cell_t *matrix_cells_arr, size_t total_cells,
+        Time_multipliers_t *multipliers_arr, size_t total_multipliers,
+        bool, double, int, bool, int64_t,
+
+        Solution_rt**, size_t*,
+        char**, char**, char**);
 
 
 #ifdef __cplusplus

include/drivers/vroom_driver.h

@@ -36,7 +36,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 extern "C" {
 #endif
 
-  void do_vrp_vroom(
+void vrp_do_vroom(
       Vroom_job_t *jobs, size_t total_jobs,
       Vroom_time_window_t *jobs_tws, size_t total_jobs_tws,
       Vroom_shipment_t *shipments, size_t total_shipments,
@@ -45,17 +45,10 @@ extern "C" {
       Vroom_break_t *breaks, size_t total_breaks,
       Vroom_time_window_t *breaks_tws, size_t total_breaks_tws,
       Vroom_matrix_t *matrix_cells_arr, size_t total_cells,
+      int32_t, int32_t, int32_t,
 
-      int32_t exploration_level,
-      int32_t timeout,
-      int32_t loading_time,
-
-      Vroom_rt **return_tuples,
-      size_t *return_count,
-
-      char ** log_msg,
-      char ** notice_msg,
-      char ** err_msg);
+      Vroom_rt**, size_t*,
+      char**, char**, char**);
 
 #ifdef __cplusplus
 }

src/common/vroom/breaks_input.c

@@ -125,12 +125,6 @@ void db_get_breaks(
 }
 
 
-
-/**
- * @param[in] sql SQL query to execute
- * @param[out] rows C Container that holds the data
- * @param[out] total_rows Total rows recieved
- */
 void
 get_vroom_breaks(
     char *sql,

src/common/vroom/jobs_input.c

@@ -151,11 +151,6 @@ void db_get_jobs(
 }
 
 
-/**
- * @param[in] sql SQL query to execute
- * @param[out] rows C Container that holds the data
- * @param[out] total_rows Total rows recieved
- */
 void
 get_vroom_jobs(
     char *sql,

src/common/vroom/matrix_input.c

@@ -124,12 +124,6 @@ void db_get_matrix(
 }
 
 
-/**
- * @param [in] sql SQL query that has the following columns: start_id, end_id, duration, cost
- * @param[in] is_plain Whether the plain or timestamp function is used
- * @param [out] rows C Container that holds all the matrix rows
- * @param [out] total_rows Total rows recieved
- */
 void
 get_vroom_matrix(
     char *sql,

src/common/vroom/shipments_input.c

@@ -153,11 +153,6 @@ void db_get_shipments(
 }
 
 
-/**
- * @param[in] sql SQL query to execute
- * @param[out] rows C Container that holds the data
- * @param[out] total_rows Total rows recieved
- */
 void
 get_vroom_shipments(
     char *sql,

src/common/vroom/time_windows_input.c

@@ -156,11 +156,6 @@ void db_get_time_windows(
 }
 
 
-/**
- * @param[in] sql SQL query to execute
- * @param[out] rows C Container that holds the data
- * @param[out] total_rows Total rows recieved
- */
 void
 get_vroom_time_windows(
     char *sql,
@@ -191,11 +186,6 @@ get_vroom_time_windows(
   db_get_time_windows(sql, rows, total_rows, info, kColumnCount, 0, is_plain);
 }
 
-/**
- * @param[in] sql SQL query to execute
- * @param[out] rows C Container that holds the data
- * @param[out] total_rows Total rows recieved
- */
 void
 get_vroom_shipments_time_windows(
     char *sql,

src/common/vroom/vehicles_input.c

@@ -169,11 +169,6 @@ void db_get_vehicles(
 }
 
 
-/**
- * @param[in] sql SQL query to execute
- * @param[out] rows C Container that holds the data
- * @param[out] total_rows Total rows recieved
- */
 void
 get_vroom_vehicles(
     char *sql,

src/compatibleVehicles/compatibleVehicles.c

@@ -179,7 +179,7 @@ process(
     char *notice_msg = NULL;
     char *err_msg = NULL;
 
-    do_compatibleVehicles(
+    vrp_do_compatibleVehicles(
             pd_orders_arr, total_pd_orders,
             vehicles_arr, total_vehicles,
             matrix_cells_arr, total_cells,

src/compatibleVehicles/compatibleVehicles_driver.cpp

@@ -95,7 +95,7 @@ digraph G {
  *
  */
 void
-do_compatibleVehicles(
+vrp_do_compatibleVehicles(
         Orders_t customers_arr[],
         size_t total_customers,
 

src/cpp_common/base_matrix.cpp

@@ -179,7 +179,7 @@ Base_Matrix::get_index(Id id) const {
 
 /** Given the internal index, returns the original node identifier
  *
- * @param [in] id
+ * @param [in] index
  * @returns the original node identifier
  *
  @dot
@@ -290,9 +290,10 @@ Base_Matrix::Base_Matrix(
 /**
  * @brief Constructor for VROOM matrix input
  *
- * @param [in] data_costs  The set of costs
- * @param [in] size_matrix The size of the set of costs
+ * @param [in] matrix_rows  The set of costs
+ * @param [in] total_matrix_rows The size of the set of costs
  * @param [in] location_ids The location identifiers
+ * @param [in] scaling_factor Multiplier
  *
  * @pre data_costs is not empty
  * @post ids has all the ids of node_ids