[llvm] 5cfb110 - [DebugInfo][NFC] Add a comment on the ordering of DILineInfo frames.

[Snehasish Kumar via llvm-commits]

Author: Snehasish Kumar
Date: 2022-03-21T10:41:05-07:00
New Revision: 5cfb1100902eba94ae8a215900aed3b92a87141a

URL: https://github.com/llvm/llvm-project/commit/5cfb1100902eba94ae8a215900aed3b92a87141a
DIFF: https://github.com/llvm/llvm-project/commit/5cfb1100902eba94ae8a215900aed3b92a87141a.diff

LOG: [DebugInfo][NFC] Add a comment on the ordering of DILineInfo frames.

Add a comment to getFrame() to mention that frames are stored in
bottom-up, i.e. leaf to root in order of increasing index.

Differential Revision: https://reviews.llvm.org/D122033

Added: 
    

Modified: 
    llvm/include/llvm/DebugInfo/DIContext.h

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/DebugInfo/DIContext.h b/llvm/include/llvm/DebugInfo/DIContext.h
index 5bddc8b52024a..a9f98588cf2dd 100644
--- a/llvm/include/llvm/DebugInfo/DIContext.h
+++ b/llvm/include/llvm/DebugInfo/DIContext.h
@@ -90,6 +90,8 @@ class DIInliningInfo {
 public:
   DIInliningInfo() = default;
 
+  /// Returns the frame at `Index`. Frames are stored in bottom-up
+  /// (leaf-to-root) order with increasing index.
   const DILineInfo &getFrame(unsigned Index) const {
     assert(Index < Frames.size());
     return Frames[Index];