[PATCH] D145989: [Propeller][ELF] Add Doxygen comment for decodeBBAddrMapPretty minor change, but I figured it would be nice to have some documentationon decodeBBAddrMap easily available in the header/doxygen for wheneversomeone needs to read through it/code...

[Aiden Grossman via Phabricator via llvm-commits]

aidengrossman created this revision.
Herald added a project: All.
aidengrossman requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

...calling it.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D145989

Files:
  llvm/include/llvm/Object/ELF.h


Index: llvm/include/llvm/Object/ELF.h
===================================================================
--- llvm/include/llvm/Object/ELF.h
+++ llvm/include/llvm/Object/ELF.h
@@ -392,6 +392,11 @@
   Expected<ArrayRef<T>> getSectionContentsAsArray(const Elf_Shdr &Sec) const;
   Expected<ArrayRef<uint8_t>> getSectionContents(const Elf_Shdr &Sec) const;
   Expected<ArrayRef<uint8_t>> getSegmentContents(const Elf_Phdr &Phdr) const;
+
+  /// Returns a vector of BBAddrMap structs corresponding to each function
+  /// within the text section that the SHT_LLVM_BB_ADDR_MAP section \p Sec
+  /// is associated with. If the current ELFFile is relocatable, a corresponding
+  /// \p RelaSec must be passed in as an argument.
   Expected<std::vector<BBAddrMap>>
   decodeBBAddrMap(const Elf_Shdr &Sec, const Elf_Shdr *RelaSec = nullptr) const;
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D145989.504851.patch
Type: text/x-patch
Size: 841 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230313/e1978f07/attachment.bin>