eeschema: fix documentation on SCH_SHEET_PATH::Cmp to match actual behavior

This commit is contained in:
unknown 2015-08-31 13:13:26 +02:00 committed by jean-pierre charras
parent b0241bacf0
commit 5fe527242f
1 changed files with 3 additions and 1 deletions

View File

@ -137,7 +137,9 @@ public:
* Function Cmp * Function Cmp
* Compare if this is the same sheet path as aSheetPathToTest * Compare if this is the same sheet path as aSheetPathToTest
* @param aSheetPathToTest = sheet path to compare * @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; int Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const;