added comments

Author: KA7E

vpr/src/pack/re_cluster_util.h

@@ -77,10 +77,13 @@ void remove_mol_from_cluster(const t_pack_molecule* molecule,
  * @param router_data: returns the intra logic block router data.
  * @param temp_cluster_pr: returns the partition region of the new cluster.
  * @param temp_cluster_noc_grp_id returns the NoC group ID of the new cluster
- * @param detailed_routing_stage: options are E_DETAILED_ROUTE_FOR_EACH_ATOM (default) and E_DETAILED_ROUTE_AT_END_ONLY
- *                                 specifies whether or not to run intra-cluster routing-based legality checking
- *                                 after adding the molecule to the cluster; default is the more conservative option,
- *                                 which is used in the top level re-clustering API functions
+ * @param detailed_routing_stage: options are E_DETAILED_ROUTE_FOR_EACH_ATOM (default) and E_DETAILED_ROUTE_AT_END_ONLY.
+ *                                This argument specifies whether or not to run an intra-cluster routing-based legality
+ *                                check after adding the molecule to the cluster; default is the more conservative option.
+ *                                This argument is passed down to try_pack_mol; if E_DETAILED_ROUTE_AT_END_ONLY is passed,
+ *                                the function does not run a detailed intra-cluster routing-based legality check.
+ *                                If many molecules will be added to a cluster, this option enables use of a single
+ *                                routing check on the completed cluster (vs many incremental checks).
  */
 bool start_new_cluster_for_mol(t_pack_molecule* molecule,
                                const t_logical_block_type_ptr& type,
@@ -106,6 +109,14 @@ bool start_new_cluster_for_mol(t_pack_molecule* molecule,
  * @param clustering_data: A data structure containing helper data for the clustering process
  *                          (is updated if this function is called during packing, especially intra_lb_routing data member).
  * @param router_data: returns the intra logic block router data.
+ * @param temp_cluster_noc_grp_id returns the NoC group ID of the new cluster
+ * @param detailed_routing_stage: options are E_DETAILED_ROUTE_FOR_EACH_ATOM (default) and E_DETAILED_ROUTE_AT_END_ONLY.
+ *                                This argument specifies whether or not to run an intra-cluster routing-based legality
+ *                                check after adding the molecule to the cluster; default is the more conservative option.
+ *                                This argument is passed down to try_pack_mol; if E_DETAILED_ROUTE_AT_END_ONLY is passed,
+ *                                the function does not run a detailed intra-cluster routing-based legality check.
+ *                                If many molecules will be added to a cluster, this option enables use of a single
+ *                                routing check on the completed cluster (vs many incremental checks).
  */
 bool pack_mol_in_existing_cluster(t_pack_molecule* molecule,
                                   int molecule_size,
@@ -115,7 +126,7 @@ bool pack_mol_in_existing_cluster(t_pack_molecule* molecule,
                                   t_clustering_data& clustering_data,
                                   t_lb_router_data*& router_data,
                                   NocGroupId& temp_cluster_noc_grp_id,
-                                 enum e_detailed_routing_stages detailed_routing_stage = E_DETAILED_ROUTE_FOR_EACH_ATOM);
+                                  enum e_detailed_routing_stages detailed_routing_stage = E_DETAILED_ROUTE_FOR_EACH_ATOM);
 
 /**
  * @brief A function that fix the clustered netlist if the move is performed