From 823f291b38eb59d5c650690939746d436cc1f290 Mon Sep 17 00:00:00 2001
From: Wenhao Lin <wenhao.lin@amd.com>
Date: Mon, 25 Nov 2024 12:41:27 -0700
Subject: [PATCH] Add Javadoc

Signed-off-by: Wenhao Lin <wenhao.lin@amd.com>
---
 .../xilinx/rapidwright/router/VersalClockRouting.java    | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/com/xilinx/rapidwright/router/VersalClockRouting.java b/src/com/xilinx/rapidwright/router/VersalClockRouting.java
index 4cfc2add7..16fa116b8 100644
--- a/src/com/xilinx/rapidwright/router/VersalClockRouting.java
+++ b/src/com/xilinx/rapidwright/router/VersalClockRouting.java
@@ -237,11 +237,12 @@ public static Map<ClockRegion, Node> routeVrouteToVerticalDistributionLines(Net
     }
 
     /**
-     * Routes from a vertical distribution centroid to destination horizontal distribution lines
-     * in the clock regions provided.
+     * For each target clock region, route from the provided vertical distribution line to a
+     * horizontal distribution line that has a GLOBAL_GLK child node in this clock region.
+     * This simulates the behavior of Vivado.
      * @param clk The current clock net
      * @param crMap A map of target clock regions and their respective vertical distribution lines
-     * @return The List of nodes from the centroid to the horizontal distribution line.
+     * @return The map of target clock regions and their respective horizontal distribution lines.
      */
     public static Map<ClockRegion, Node> routeVerticalToHorizontalDistributionLines(Net clk,
                                                                                     Map<ClockRegion, Node> crMap,
@@ -377,7 +378,7 @@ public static void routeToLCBs(Net clk, Map<ClockRegion, Set<NodeWithPrevAndCost
      * @param vroute The node to start the route.
      * @param clockRegions Target clock regions.
      * @param down To indicate if it is routing to the group of top clock regions.
-     * @return A list of RouteNodes indicating the reached horizontal distribution lines.
+     * @return The map of target clock regions and their respective horizontal distribution lines.
      */
     public static Map<ClockRegion, Node> routeToHorizontalDistributionLines(Net clk,
                                                                             Node vroute,