mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-25 12:12:47 +01:00
0bad578cf3
Looking at the Doxygen-generated documentation for the llvm namespace
currently shows all sorts of random comments from different parts of the
codebase. These are mostly caused by:
- File doc comments that aren't marked with \file, so they're attached to
the next declaration, which is usually "namespace llvm {".
- Class doc comments placed before the namespace rather than before the
class.
- Code comments before the namespace that (in my opinion) shouldn't be
extracted by doxygen at all.
This commit fixes these comments. The generated doxygen documentation now
has proper docs for several classes and files, and the docs for the llvm
and llvm::detail namespaces are now empty.
Reviewed By: thakis, mizvekov
Differential Revision: https://reviews.llvm.org/D96736
48 lines
1.7 KiB
C++
48 lines
1.7 KiB
C++
//===- ELFObjHandler.h ------------------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===-----------------------------------------------------------------------===/
|
|
/// \file
|
|
/// This supports reading and writing of elf dynamic shared objects.
|
|
///
|
|
//===-----------------------------------------------------------------------===/
|
|
|
|
#ifndef LLVM_INTERFACESTUB_ELFOBJHANDLER_H
|
|
#define LLVM_INTERFACESTUB_ELFOBJHANDLER_H
|
|
|
|
#include "llvm/InterfaceStub/ELFStub.h"
|
|
#include "llvm/Object/ELFObjectFile.h"
|
|
#include "llvm/Object/ELFTypes.h"
|
|
#include "llvm/Support/FileSystem.h"
|
|
|
|
namespace llvm {
|
|
|
|
class MemoryBuffer;
|
|
|
|
namespace elfabi {
|
|
|
|
enum class ELFTarget { ELF32LE, ELF32BE, ELF64LE, ELF64BE };
|
|
|
|
/// Attempt to read a binary ELF file from a MemoryBuffer.
|
|
Expected<std::unique_ptr<ELFStub>> readELFFile(MemoryBufferRef Buf);
|
|
|
|
/// Attempt to write a binary ELF stub.
|
|
/// This function determines appropriate ELFType using the passed ELFTarget and
|
|
/// then writes a binary ELF stub to a specified file path.
|
|
///
|
|
/// @param FilePath File path for writing the ELF binary.
|
|
/// @param Stub Source ELFStub to generate a binary ELF stub from.
|
|
/// @param OutputFormat Target ELFType to write binary as.
|
|
/// @param WriteIfChanged Whether or not to preserve timestamp if
|
|
/// the output stays the same.
|
|
Error writeBinaryStub(StringRef FilePath, const ELFStub &Stub,
|
|
ELFTarget OutputFormat, bool WriteIfChanged = false);
|
|
|
|
} // end namespace elfabi
|
|
} // end namespace llvm
|
|
|
|
#endif // LLVM_INTERFACESTUB_ELFOBJHANDLER_H
|