doxygen comment for get_parallel_seg_index

Author: soheilshahrouz

libs/librrgraph/src/base/get_parallel_segs.h

@@ -22,6 +22,17 @@ std::vector<t_segment_inf> get_parallel_segs(const std::vector<t_segment_inf>& s
                                              e_parallel_axis parallel_axis,
                                              bool keep_original_index = false);
 
-int get_parallel_seg_index(int abs,
+/**
+ * @brief Retrieves the segment index in an axis-specific segment list.
+ *
+ * @param abs_index     Index of the segment in the unified segment list.
+ * @param index_map     Mapping from unified indices to (axis-specific index, axis).
+ *                      This map must have been populated by `get_parallel_segs()`.
+ * @param parallel_axis Axis to resolve ambiguous mappings for segments usable on multiple axes.
+ *
+ * @return The index of the segment in the axis-specific list if found, otherwise -1.
+ */
+
+int get_parallel_seg_index(int abs_index,
                            const t_unified_to_parallel_seg_index& index_map,
                            e_parallel_axis parallel_axis);