Skip to content

Commit 463dd2f

Browse files
added parameter list to the doxygen comment of PlacerCriticalities constructor
1 parent 9933fc6 commit 463dd2f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

vpr/src/place/timing/PlacerCriticalities.h

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,16 @@ class PlacerCriticalities {
8686

8787
public: //Lifetime
8888

89-
///@brief Allocates space for the timing_place_crit_ data structure.
89+
/**
90+
* @brief Allocates space for the timing_place_crit_ data structure.
91+
* @param clb_nlist Used to lookup and iterate clustered netlist connections.
92+
* @param netlist_pin_lookup Used to lookup Atom/Clustered pins connected to a Clustered/Atom pin.
93+
* @param timing_info Holds setup timing info.
94+
*
95+
* @note timing_info may be shared by multiple objects with different lifetimes.
96+
* To ensure timing_info is destroyed only after all its user object are destructed,
97+
* each user object should hold a shared_ptr to it.
98+
*/
9099
PlacerCriticalities(const ClusteredNetlist& clb_nlist,
91100
const ClusteredPinAtomPinsLookup& netlist_pin_lookup,
92101
std::shared_ptr<const SetupTimingInfo> timing_info);

0 commit comments

Comments
 (0)