add note for explaining data structure std::map<std::size_t, std::set…

…<std::size_t>> in TelegramOptions::get_map_of_sets
w0lek · Jun 7, 2024 · c634775 · c634775
1 parent 73fc03c
commit c634775
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/vpr/src/server/telegramoptions.h b/vpr/src/server/telegramoptions.h
@@ -62,6 +62,8 @@ class TelegramOptions {
      *
      * This function retrieves a map of sets associated with the specified key.
      *
+     * @note The map of sets is used to store the critical path index (map key) and the associated set of selected sub-path element indexes (map value).
+     *
      * @param key The key of the map of sets to retrieve.
      * @return The map of sets associated with the specified key.
      */