Update comments

Signed-off-by: Eddie Hung <[email protected]>

src/com/xilinx/rapidwright/util/ReportRouteStatus.java

@@ -37,8 +37,13 @@
 
 public class ReportRouteStatus {
     /**
-     * Compute the route status of given Design's physical nets by examining the SitePinInst.isRouted()
-     * state of each net's pins, as well as to discovering node conflicts between each net's PIPs.
+     * Compute the route status of given Design's physical nets by examining the
+     * {@link SitePinInst#isRouted()} state of each net's pins, as well as to discovering node conflicts
+     * between each net's PIPs.
+     * Freshly loaded designs, as well as designs that are not up-to-date, can call
+     * {@link DesignTools#updatePinsIsRouted(Design)} for recomputing the SitePinInst.isRouted() state.
+     * Note that currently this method does not check the Design's logical netlist nor its physical
+     * placement --- these are assumed to be correct.
      * @param design Design to examine.
      * @return ReportRouteStatusResult object.
      */
@@ -102,6 +107,9 @@ public static void main(String[] args) {
         DesignTools.updatePinsIsRouted(design);
 
         ReportRouteStatusResult rrs = reportRouteStatus(design);
+
+        // Print out the result in Vivado's style -- note that this analysis differs from Vivado in that
+        // only physical nets are examined.
         int numPhysicalNets = design.getNets().size();
         System.out.println();
         System.out.println("RapidWright Design Route Status");

src/com/xilinx/rapidwright/util/ReportRouteStatusResult.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, Advanced Micro Devices, Inc.
+ * Copyright (c) 2023-2024, Advanced Micro Devices, Inc.
  * All rights reserved.
  *
  * Author: Zak Nafziger, Advanced Micro Devices, Inc.