[clang-tools-extra] [clangd] Document the cases in which Dex::Files and IdxContents are populated (PR #118906)

Nathan Ridge via cfe-commits cfe-commits at lists.llvm.org
Sat Dec 7 18:13:35 PST 2024


https://github.com/HighCommander4 updated https://github.com/llvm/llvm-project/pull/118906

>From 45311dbceed8d438f2ac0db5019719a7fa32c0bf Mon Sep 17 00:00:00 2001
From: Nathan Ridge <zeratul976 at hotmail.com>
Date: Thu, 5 Dec 2024 19:45:25 -0500
Subject: [PATCH] [clangd] Add clarifying comment about when Dex::IdxContents
 is populated

---
 clang-tools-extra/clangd/index/dex/Dex.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/clang-tools-extra/clangd/index/dex/Dex.h b/clang-tools-extra/clangd/index/dex/Dex.h
index 69e161d51135b6..dc8c5b44c418f9 100644
--- a/clang-tools-extra/clangd/index/dex/Dex.h
+++ b/clang-tools-extra/clangd/index/dex/Dex.h
@@ -123,6 +123,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;
   // Size of memory retained by KeepAlive.
   size_t BackingDataSize = 0;



More information about the cfe-commits mailing list