[Propeller][ELF] Add Doxygen comment for decodeBBAddrMap
authorAiden Grossman <agrossman154@yahoo.com>
Mon, 13 Mar 2023 21:43:05 +0000 (21:43 +0000)
committerAiden Grossman <agrossman154@yahoo.com>
Mon, 13 Mar 2023 22:14:58 +0000 (15:14 -0700)
commitf18915da1d64646a0c663a61368b30b71a494461
tree8fc6a823e0ebdc715d4b4f90fa715b1ddfa6c987
parent5d2ddb129c9b7e6e837a524ea7492c2ba8f3c6af
[Propeller][ELF] Add Doxygen comment for decodeBBAddrMap

Adds a doxygen comment on decodeBBAddrMap specifying what it does as well
as some requirements that need to be met when calling it (especially
the condition of passing in a relocation section when the ELFFile is
relocatable).

Differential Revision: https://reviews.llvm.org/D145989
llvm/include/llvm/Object/ELF.h