(doxy) Removing doxygen errors

pgRouting · Aug 20, 2024 · 2501d35 · 2501d35
1 parent 4580137
commit 2501d35
Show file tree

Hide file tree

Showing 10 changed files with 83 additions and 123 deletions.
diff --git a/include/cpp_common/get_check_data.hpp b/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);

diff --git a/src/common/vroom/breaks_input.c b/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,

diff --git a/src/common/vroom/jobs_input.c b/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,

diff --git a/src/common/vroom/matrix_input.c b/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,

diff --git a/src/common/vroom/shipments_input.c b/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,

diff --git a/src/common/vroom/time_windows_input.c b/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,

diff --git a/src/common/vroom/vehicles_input.c b/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,

diff --git a/src/cpp_common/base_matrix.cpp b/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