[PATCH] D114429: [objcopy][NFC] Add doc comments to the executeObjcopy* functions.

[Alexey Lapshin via Phabricator via llvm-commits]

avl created this revision.
avl added reviewers: jhenderson, alexander-shaposhnikov, rupprecht, MaskRay.
Herald added subscribers: abrachet, sbc100, emaste.
avl requested review of this revision.
Herald added subscribers: llvm-commits, aheejin.
Herald added a project: LLVM.

Depends on D88827 <https://reviews.llvm.org/D88827>


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D114429

Files:
  llvm/include/llvm/Object/ObjCopy/COFF/COFFObjcopy.h
  llvm/include/llvm/Object/ObjCopy/ELF/ELFObjcopy.h
  llvm/include/llvm/Object/ObjCopy/MachO/MachOObjcopy.h
  llvm/include/llvm/Object/ObjCopy/wasm/WasmObjcopy.h


Index: llvm/include/llvm/Object/ObjCopy/wasm/WasmObjcopy.h
===================================================================
--- llvm/include/llvm/Object/ObjCopy/wasm/WasmObjcopy.h
+++ llvm/include/llvm/Object/ObjCopy/wasm/WasmObjcopy.h
@@ -22,6 +22,9 @@
 struct WasmConfig;
 
 namespace wasm {
+/// Applies the transformations described by \p Config to
+/// \p In(FileFormat::Unspecified) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnBinary(const CommonConfig &Config, const WasmConfig &,
                              object::WasmObjectFile &In, raw_ostream &Out);
 
Index: llvm/include/llvm/Object/ObjCopy/MachO/MachOObjcopy.h
===================================================================
--- llvm/include/llvm/Object/ObjCopy/MachO/MachOObjcopy.h
+++ llvm/include/llvm/Object/ObjCopy/MachO/MachOObjcopy.h
@@ -24,10 +24,16 @@
 class MultiFormatConfig;
 
 namespace macho {
+/// Applies the transformations described by \p Config and \p MachOConfig to
+/// \p In(FileFormat::Unspecified) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnBinary(const CommonConfig &Config,
                              const MachOConfig &MachOConfig,
                              object::MachOObjectFile &In, raw_ostream &Out);
 
+/// Applies the transformations described by \p Config and \p MachOConfig to
+/// \p In(FileFormat::Unspecified) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnMachOUniversalBinary(
     const MultiFormatConfig &Config, const object::MachOUniversalBinary &In,
     raw_ostream &Out);
Index: llvm/include/llvm/Object/ObjCopy/ELF/ELFObjcopy.h
===================================================================
--- llvm/include/llvm/Object/ObjCopy/ELF/ELFObjcopy.h
+++ llvm/include/llvm/Object/ObjCopy/ELF/ELFObjcopy.h
@@ -23,14 +23,24 @@
 struct ELFConfig;
 
 namespace elf {
+/// Applies the transformations described by \p Config and \p ELFConfig to
+/// \p In(FileFormat::IHex) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnIHex(const CommonConfig &Config,
                            const ELFConfig &ELFConfig, MemoryBuffer &In,
                            raw_ostream &Out);
 
+/// Applies the transformations described by \p Config and \p ELFConfig to
+/// \p In(FileFormat::Binary) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnRawBinary(const CommonConfig &Config,
                                 const ELFConfig &ELFConfig, MemoryBuffer &In,
                                 raw_ostream &Out);
 
+/// Applies the transformations described by \p Config and \p ELFConfig to
+/// \p In(FileFormat::ELF or FileFormat::Unspecified) and writes
+/// the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnBinary(const CommonConfig &Config,
                              const ELFConfig &ELFConfig,
                              object::ELFObjectFileBase &In, raw_ostream &Out);
Index: llvm/include/llvm/Object/ObjCopy/COFF/COFFObjcopy.h
===================================================================
--- llvm/include/llvm/Object/ObjCopy/COFF/COFFObjcopy.h
+++ llvm/include/llvm/Object/ObjCopy/COFF/COFFObjcopy.h
@@ -23,6 +23,9 @@
 
 namespace coff {
 
+/// Applies the transformations described by \p Config to
+/// \p In(FileFormat::Unspecified) and writes the result into \p Out.
+/// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnBinary(const CommonConfig &Config, const COFFConfig &,
                              object::COFFObjectFile &In, raw_ostream &Out);
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D114429.389144.patch
Type: text/x-patch
Size: 3903 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20211123/406c9dff/attachment.bin>