From f44d50aea34e7af2e473c637caf65f2069832536 Mon Sep 17 00:00:00 2001
From: Michael Beardsworth <beardsworth@google.com>
Date: Thu, 27 Aug 2015 21:25:09 -0700
Subject: [PATCH] eeschema: fix documentation on SCH_SHEET_PATH::Cmp to match
 current behavior

---
 eeschema/sch_sheet_path.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/eeschema/sch_sheet_path.h b/eeschema/sch_sheet_path.h
index 5cd60bc..939d899 100644
--- a/eeschema/sch_sheet_path.h
+++ b/eeschema/sch_sheet_path.h
@@ -137,7 +137,9 @@ public:
      * Function Cmp
      * Compare if this is the same sheet path as aSheetPathToTest
      * @param aSheetPathToTest = sheet path to compare
-     * @return -1 if different, 0 if same
+     * @return 1 if this sheet path has more sheets than aSheetPathToTest, 
+     *   -1 if this sheet path has fewer sheets than aSheetPathToTest, 
+     *   or 0 if same
      */
     int Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const;
 
-- 
2.1.1

