summaryrefslogtreecommitdiff
path: root/clang-tools-extra
diff options
context:
space:
mode:
authorKirill Bobyrev <kbobyrev.opensource@gmail.com>2018-09-26 14:59:49 +0000
committerKirill Bobyrev <kbobyrev.opensource@gmail.com>2018-09-26 14:59:49 +0000
commit5f27da1df1ef800bc0f7a8831112fbddf6d411b6 (patch)
tree67f51f1eb2d61515f7ad1c98b6711be7d607aa53 /clang-tools-extra
parent82a70908f0ccc4f9b9f74e16673cc8170de88928 (diff)
[docs] Update PostingList string representation format
Because `PostingList` objects are compressed, it is now impossible to see elements other than the current one and the documentation doesn't match implementation anymore. Reviewed By: ioeric Differential Revision: https://reviews.llvm.org/D52545
Diffstat (limited to 'clang-tools-extra')
-rw-r--r--clang-tools-extra/clangd/index/dex/Iterator.h5
1 files changed, 2 insertions, 3 deletions
diff --git a/clang-tools-extra/clangd/index/dex/Iterator.h b/clang-tools-extra/clangd/index/dex/Iterator.h
index 5e5460f0125..3066a8c7846 100644
--- a/clang-tools-extra/clangd/index/dex/Iterator.h
+++ b/clang-tools-extra/clangd/index/dex/Iterator.h
@@ -94,9 +94,8 @@ public:
///
/// Where Type is the iterator type representation: "&" for And, "|" for Or,
/// ChildN is N-th iterator child. Raw iterators over PostingList are
- /// represented as "[ID1, ID2, ..., {IDN}, ... END]" where IDN is N-th
- /// PostingList entry and the element which is pointed to by the PostingList
- /// iterator is enclosed in {} braces.
+ /// represented as "[... CurID ...]" where CurID is the current PostingList
+ /// entry being inspected.
friend llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
const Iterator &Iterator) {
return Iterator.dump(OS);