add file comments for placer.h and place_log_util.h

Author: soheilshahrouz

vpr/src/place/place.h

@@ -1,5 +1,5 @@
-#ifndef VPR_PLACE_H
-#define VPR_PLACE_H
+
+#pragma once
 
 #include "vpr_types.h"
 
@@ -13,5 +13,3 @@ void try_place(const Netlist<>& net_list,
                std::vector<t_segment_inf>& segment_inf,
                const std::vector<t_direct_inf>& directs,
                bool is_flat);
-
-#endif

vpr/src/place/place_log_util.h

@@ -1,3 +1,20 @@
+/**
+ * @file placement_log_printer.h
+ * @brief Declares the PlacementLogPrinter class and associated utilities for logging
+ * and reporting placement-related statistics and timing analysis results.
+ *
+ * This file provides tools to monitor and report the progress and results of the placement stage.
+ *
+ * ### Key Components:
+ * - **PlacementLogPrinter**:
+ *   - A utility class for logging placement status, resource utilization, and swap statistics.
+ *   - Prints detailed statistics during the placement process, including initial and post-placement states.
+ *   - Supports a "quiet mode" to suppress output.
+ *
+ * ### Integration:
+ * The tools in this file integrate with the Placer class to provide information about
+ * the placement process for debugging, optimization, and analysis purposes.
+ */
 
 #pragma once
 

vpr/src/place/placer.h

@@ -1,3 +1,19 @@
+/**
+ * @file placer.h
+ * @brief Declares the Placer class, which encapsulates the functionality, data structures,
+ * and algorithms required for the placement stage.
+ *
+ * The Placer class initializes necessary objects, performs an initial placement,
+ * and runs simulated annealing optimization. This optimization minimizes
+ * wirelength (bounding box) and timing costs to achieve an efficient placement solution.
+ *
+ * Key features of the Placer class:
+ * - Encapsulates all placement-related variables, cost functions, and data structures.
+ * - Supports optional NoC (Network-on-Chip) cost optimizations if enabled.
+ * - Interfaces with timing analysis, placement delay calculation.
+ * - Provides a mechanism for checkpointing the placement state.
+ * - Includes debugging and validation utilities to verify the correctness of placement.
+ */
 
 #pragma once