Fix docstrings

Author: Grufoony

src/dsf/base/Network.hpp

@@ -42,7 +42,6 @@ namespace dsf {
     /// @brief Add a node to the network
     /// @tparam TNode The type of the node (default is node_t)
     /// @tparam TArgs The types of the arguments
-    /// @param nodeId The node's id
     /// @param args The arguments to pass to the node's constructor
     template <typename TNode = node_t, typename... TArgs>
       requires(std::is_base_of_v<node_t, TNode> &&
@@ -56,7 +55,6 @@ namespace dsf {
     /// @brief Add an edge to the network
     /// @tparam TEdge The type of the edge (default is edge_t)
     /// @tparam TArgs The types of the arguments
-    /// @param edgeId The edge's id
     /// @param args The arguments to pass to the edge's constructor
     template <typename TEdge = edge_t, typename... TArgs>
       requires(std::is_base_of_v<edge_t, TEdge> &&

src/dsf/mobility/Itinerary.hpp

@@ -30,6 +30,7 @@ namespace dsf::mobility {
 
   public:
     /// @brief Construct a new Itinerary object
+    /// @param id The itinerary's id
     /// @param destination The itinerary's destination
     Itinerary(Id id, Id destination);
 

src/dsf/mobility/Road.hpp

@@ -28,6 +28,7 @@ namespace dsf::mobility {
     /// @param nLanes The road's number of lanes (default is 1)
     /// @param maxSpeed The road's speed limit, in m/s (default is 50 km/h)
     /// @param name The road's name (default is an empty string)
+    /// @param geometry The road's geometry (default is empty)
     /// @param capacity The road's capacity (default is the maximum number of vehicles that can fit in the road)
     /// @param transportCapacity The road's transport capacity (default is 1)
     Road(Id id,

src/dsf/mobility/RoadDynamics.hpp

@@ -348,12 +348,14 @@ namespace dsf::mobility {
     /// @brief Save the street densities in csv format
     /// @param filename The name of the file (default is "{datetime}_{simulation_name}_street_densities.csv")
     /// @param normalized If true, the densities are normalized in [0, 1]
+    /// @param separator The separator character (default is ';')
     void saveStreetDensities(std::string filename = std::string(),
                              bool normalized = true,
                              char const separator = ';') const;
     /// @brief Save the street input counts in csv format
     /// @param filename The name of the file
     /// @param reset If true, the input counts are cleared after the computation
+    /// @param separator The separator character (default is ';')
     /// @details NOTE: counts are saved only if the street has a coil on it
     void saveCoilCounts(const std::string& filename,
                         bool reset = false,

src/dsf/mobility/RoadNetwork.hpp

@@ -119,10 +119,12 @@ namespace dsf::mobility {
     /// - forbiddenTurns: The forbidden turns of the street, encoding information about street into which the street cannot output agents. The format is a string "sourceId1-targetid1, sourceId2-targetid2,..."
     /// - coilcode: An integer code to identify the coil located on the street
     /// - customWeight: will be stored in the `weight` parameter of the Edge class. You can use it for the shortest path via dsf::weight_functions::customWeight.
+    /// @param args Additional arguments
     template <typename... TArgs>
     void importEdges(const std::string& fileName, TArgs&&... args);
     /// @brief Import the graph's nodes properties from a file
     /// @param fileName The name of the file to import the nodes properties from.
+    /// @param args Additional arguments
     /// @details Supports csv file format. Please specify the separator as second parameter.
     /// Supported fields:
     /// - id: The id of the node

src/dsf/mobility/Street.hpp

@@ -59,6 +59,7 @@ namespace dsf::mobility {
     /// @param nLanes The street's number of lanes (default is 1)
     /// @param maxSpeed The street's speed limit, in m/s (default is 50 km/h)
     /// @param name The street's name (default is an empty string)
+    /// @param geometry The street's geometry
     /// @param capacity The street's capacity (default is the maximum number of vehicles that can fit in the street)
     /// @param transportCapacity The street's transport capacity (default is 1)
     Street(Id id,
@@ -79,6 +80,7 @@ namespace dsf::mobility {
     void setLaneMapping(std::vector<Direction> const& laneMapping);
     /// @brief Set the street's queue
     /// @param queue The street's queue
+    /// @param index The index of the queue
     void setQueue(dsf::queue<std::unique_ptr<Agent>> queue, size_t index);
     /// @brief Set the mean vehicle length
     /// @param meanVehicleLength The mean vehicle length
@@ -155,7 +157,7 @@ namespace dsf::mobility {
     /// @param pAgent The agent to add to the street
     virtual void addAgent(std::unique_ptr<Agent> pAgent);
     /// @brief Add an agent to the street's queue
-    /// @param agentId The id of the agent to add to the street's queue
+    /// @param queueId The id of the queue
     /// @throw std::runtime_error If the street's queue is full
     void enqueue(size_t const& queueId);
     /// @brief Remove an agent from the street's queue