Skip to content

Commit 3a92443

Browse files
committed
[gardening] Format two doxygen comments according to LLVM style guide. NFC.
1 parent 21d0815 commit 3a92443

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

include/swift/SILOptimizer/Analysis/AliasAnalysis.h

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,24 +22,26 @@
2222
using swift::RetainObserveKind;
2323

2424
namespace {
25-
/// A cache for AliasAnalysis.
26-
/// This struct represents the argument list to the method 'alias'.
27-
/// The two SILValue pointers are mapped to size_t indices because we need
28-
/// an efficient way to invalidate them (the mechanism is described below).
29-
/// The Type arguments are translated to void* because their
30-
/// underlying storage is opaque pointers that never goes away.
25+
/// A key used for the AliasAnalysis cache.
26+
///
27+
/// This struct represents the argument list to the method 'alias'. The two
28+
/// SILValue pointers are mapped to size_t indices because we need an
29+
/// efficient way to invalidate them (the mechanism is described below). The
30+
/// Type arguments are translated to void* because their underlying storage is
31+
/// opaque pointers that never goes away.
3132
struct AliasKeyTy {
3233
// The SILValue pair:
3334
size_t V1, V2;
3435
// The TBAAType pair:
3536
void *T1, *T2;
3637
};
3738

38-
/// A cache for MemoryBehavior Analysis.
39-
/// The two SILValue pointers are mapped to size_t indices because we need
40-
/// an efficient way to invalidate them (the mechanism is described below).
41-
/// The RetainObserveKind represents the inspection mode for the memory
42-
/// behavior analysis.
39+
/// A key used for for the MemoryBehavior Analysis cache.
40+
///
41+
/// The two SILValue pointers are mapped to size_t indices because we need an
42+
/// efficient way to invalidate them (the mechanism is described below). The
43+
/// RetainObserveKind represents the inspection mode for the memory behavior
44+
/// analysis.
4345
struct MemBehaviorKeyTy {
4446
// The SILValue pair:
4547
size_t V1, V2;
@@ -100,11 +102,13 @@ class AliasAnalysis : public SILAnalysis {
100102
llvm::DenseMap<TBAACacheKey, bool> TypesMayAliasCache;
101103

102104
/// AliasAnalysis value cache.
105+
///
103106
/// The alias() method uses this map to cache queries.
104107
llvm::DenseMap<AliasKeyTy, AliasResult> AliasCache;
105108

106109
using MemoryBehavior = SILInstruction::MemoryBehavior;
107110
/// MemoryBehavior value cache.
111+
///
108112
/// The computeMemoryBehavior() method uses this map to cache queries.
109113
llvm::DenseMap<MemBehaviorKeyTy, MemoryBehavior> MemoryBehaviorCache;
110114

0 commit comments

Comments
 (0)