[clang-tools-extra] 26760c7 - [clangd] Add clarifying comment about when Dex::IdxContents is populated (#118906)

[via cfe-commits]

Author: Nathan Ridge
Date: 2024-12-09T02:23:11-05:00
New Revision: 26760c7b907c1012c44d15959319bfa06848e5cd

URL: https://github.com/llvm/llvm-project/commit/26760c7b907c1012c44d15959319bfa06848e5cd
DIFF: https://github.com/llvm/llvm-project/commit/26760c7b907c1012c44d15959319bfa06848e5cd.diff

LOG: [clangd] Add clarifying comment about when Dex::IdxContents is populated (#118906)

Added: 
    

Modified: 
    clang-tools-extra/clangd/index/dex/Dex.h

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/clangd/index/dex/Dex.h b/clang-tools-extra/clangd/index/dex/Dex.h
index 46efbc6c699cab..502f597d81ef07 100644
--- a/clang-tools-extra/clangd/index/dex/Dex.h
+++ b/clang-tools-extra/clangd/index/dex/Dex.h
@@ -146,6 +146,8 @@ class Dex : public SymbolIndex {
   // Set of files which were used during this index build.
   llvm::StringSet<> Files;
   // Contents of the index (symbols, references, etc.)
+  // This is only populated if `Files` is, which applies to some but not all
+  // consumers of this class.
   IndexContents IdxContents = IndexContents::None;
   // Size of memory retained by KeepAlive.
   size_t BackingDataSize = 0;