diff --git a/doc/src/api/vpr/server.rst b/doc/src/api/vpr/server.rst index b0176f858da..2bda680bbc1 100644 --- a/doc/src/api/vpr/server.rst +++ b/doc/src/api/vpr/server.rst @@ -39,6 +39,9 @@ server::TaskResolver .. doxygenfunction:: server::calc_critical_path :project: vpr +.. doxygenenum:: e_timing_report_detail + :project: vpr + comm::Telegram -------------- @@ -77,4 +80,4 @@ Compression utils :project: vpr .. doxygenfunction:: try_decompress - :project: vpr \ No newline at end of file + :project: vpr diff --git a/vpr/src/server/pathhelper.h b/vpr/src/server/pathhelper.h index 0a62cf5e625..8d2244a885a 100644 --- a/vpr/src/server/pathhelper.h +++ b/vpr/src/server/pathhelper.h @@ -40,9 +40,9 @@ using CritPathsResultPtr = std::shared_ptr; * @brief Calculates the critical path. * This function calculates the critical path based on the provided parameters. -* @param type The type of the critical path. -* @param crit_path_num The max number of the critical path. -* @param details_level The level of detail for the timing report. +* @param type The type of the critical path. Must be either "setup" or "hold". +* @param crit_path_num The max number of critical paths to record. +* @param details_level The level of detail for the timing report. See @ref e_timing_report_detail. * @param is_flat_routing Indicates whether flat routing should be used. * @return A `CritPathsResultPtr` which is a pointer to the result of the critical path calculation (see @ref CritPathsResult). */