[AliasAnalysis] Clean some of the docs.

Move some comments from the definition to the decleration and tidy
some of the comments.

Author: nadavrot

Diff for: include/swift/SILAnalysis/AliasAnalysis.h

@@ -113,7 +113,8 @@ class AliasAnalysis : public SILAnalysis {
   MemoryBehavior getMemoryBehavior(SILInstruction *Inst, SILValue V,
                                    RetainObserveKind);
 
-  /// Returns true if Inst may read from memory in a manner that affects V.
+  /// Returns true if \p Inst may read from memory in a manner that
+  /// affects V.
   bool mayReadFromMemory(SILInstruction *Inst, SILValue V) {
     MemoryBehavior B = getMemoryBehavior(Inst, V,
                                          RetainObserveKind::IgnoreRetains);
@@ -122,7 +123,8 @@ class AliasAnalysis : public SILAnalysis {
       B == MemoryBehavior::MayHaveSideEffects;
   }
 
-  /// Returns true if Inst may write to memory in a manner that affects V.
+  /// Returns true if \p Inst may write to memory in a manner that
+  /// affects V.
   bool mayWriteToMemory(SILInstruction *Inst, SILValue V) {
     MemoryBehavior B = getMemoryBehavior(Inst, V,
                                          RetainObserveKind::IgnoreRetains);
@@ -131,8 +133,8 @@ class AliasAnalysis : public SILAnalysis {
       B == MemoryBehavior::MayHaveSideEffects;
   }
 
-  /// Returns true if Inst may read or write to memory in a manner that affects
-  /// V.
+  /// Returns true if \p Inst may read or write to memory in a manner that
+  /// affects V.
   bool mayReadOrWriteMemory(SILInstruction *Inst, SILValue V) {
     auto B = getMemoryBehavior(Inst, V, RetainObserveKind::IgnoreRetains);
     return B != MemoryBehavior::None;
@@ -169,7 +171,8 @@ llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
 /// Otherwise, return an empty type.
 SILType computeTBAAType(SILValue V);
 
-/// Check if V points to a let-variable.
+/// Check if \p V points to a let-member.
+/// Nobody can write into let members.
 bool isLetPointer(SILValue V);
 
 } // end namespace swift

Diff for: lib/SILAnalysis/AliasAnalysis.cpp

@@ -699,10 +699,8 @@ AliasResult AliasAnalysis::aliasInner(SILValue V1, SILValue V2,
   return AliasResult::MayAlias;
 }
 
-/// Check if this is the address of a "let" member.
-/// Nobody can write into let members.
 bool swift::isLetPointer(SILValue V) {
-  // Traverse the "access" path for V and check that starts with "let"
+  // Traverse the "access" path for V and check that it starts with "let"
   // and everything along this path is a value-type (i.e. struct or tuple).
 
   // Is this an address of a "let" class member?