Skip to content

Commit 355c588

Browse files
committed
[NFC] A doc comment explaining the SymExpr::getSymbolID()
1 parent d32f6ab commit 355c588

File tree

1 file changed

+6
-0
lines changed
  • clang/include/clang/StaticAnalyzer/Core/PathSensitive

1 file changed

+6
-0
lines changed

clang/include/clang/StaticAnalyzer/Core/PathSensitive/SymExpr.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ class SymExpr : public llvm::FoldingSetNode {
6868

6969
Kind getKind() const { return K; }
7070

71+
/// Get a unique identifier for this symbol.
72+
/// The ID is unique across all SymExprs in a SymbolManager.
73+
/// They reflect the allocation order of these SymExprs,
74+
/// and are likely stable across runs.
75+
/// Used as a key in SymbolRef containers and as part of identity
76+
/// for SymbolData, e.g. SymbolConjured with ID = 7 is "conj_$7".
7177
SymbolID getSymbolID() const { return Sym; }
7278

7379
virtual void dump() const;

0 commit comments

Comments
 (0)