hermespy-rt

commit 80bc9eec03b17ba66a226dadb3e6d767e5277cbf
parent e13f88ba34de4921490bb55a9f0911bcb4f269d9
Author: Egor Achkasov <eaachkasov@edu.hse.ru>
Date:   Wed,  4 Dec 2024 12:17:31 +0100

Prettify compute_paths doc comment

Diffstat:
M
compute_paths.h
 | 
14
+++++++-------

1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/compute_paths.h b/compute_paths.h
@@ -23,21 +23,21 @@
  * \param num_tx number of transmitters. Must be > 0
  * \param num_paths number of paths to compute. Must be > 0
  * \param a output array of gains, shape (num_paths,)
- * \param tau output array of delays, shape (num_paths,)
+ * \param tau output array of delays in seconds, shape (num_paths,)
 */
 void compute_paths(
-    IN const char *mesh_filepath, /* path to the mesh file */
+    IN const char *mesh_filepath,  /* path to the mesh file */
     IN const float *rx_positions,  /* shape (num_rx, 3) */
     IN const float *tx_positions,  /* shape (num_tx, 3) */
     IN const float *rx_velocities, /* shape (num_rx, 3) */
     IN const float *tx_velocities, /* shape (num_tx, 3) */
     IN float carrier_frequency,    /* > 0.0 */
-    IN size_t num_rx,                 /* number of receivers */
-    IN size_t num_tx,                 /* number of transmitters */
-    IN size_t num_paths,              /* number of paths */
-    IN size_t num_bounces,            /* number of bounces */
+    IN size_t num_rx,              /* number of receivers */
+    IN size_t num_tx,              /* number of transmitters */
+    IN size_t num_paths,           /* number of paths */
+    IN size_t num_bounces,         /* number of bounces */
     OUT float *a,                  /* output array of gains (num_paths,) */
-    OUT float *tau               /* output array of delays (num_paths,) */
+    OUT float *tau                 /* output array of delays in seconds (num_paths,) */
 );
 
 #endif  /* COMPUTE_PATHS_H */