diff options
Diffstat (limited to 'src/intervals.h')
| -rw-r--r-- | src/intervals.h | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/src/intervals.h b/src/intervals.h index 9c5adf33a14..e9166946d9a 100644 --- a/src/intervals.h +++ b/src/intervals.h @@ -31,11 +31,15 @@ struct interval /* The first group of entries deal with the tree structure. */ ptrdiff_t total_length; /* Length of myself and both children. */ ptrdiff_t position; /* Cache of interval's character position. */ - /* This field is usually updated - simultaneously with an interval - traversal, there is no guarantee - that it is valid for a random - interval. */ + /* This field is valid in the final + target interval returned by + find_interval, next_interval, + previous_interval and + update_interval. It cannot be + depended upon in any intermediate + intervals traversed by these + functions, or any other + interval. */ struct interval *left; /* Intervals which precede me. */ struct interval *right; /* Intervals which succeed me. */ |