Author: jdevlieghere
Date: Thu Feb 22 03:43:43 2018
New Revision: 325769
URL: http://llvm.org/viewvc/llvm-project?rev=325769&view=rev
Log:
[dsymutil] Remove \brief from comments. NFC
With autobrief enabled, these server no purpose anymore. Most of them
were already removed but this makes everything consistent.
Modified:
llvm/trunk/tools/dsymutil/BinaryHolder.h
llvm/trunk/tools/dsymutil/DebugMap.h
llvm/trunk/tools/dsymutil/MachODebugMapParser.cpp
llvm/trunk/tools/dsymutil/dsymutil.h
Modified: llvm/trunk/tools/dsymutil/BinaryHolder.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/dsymutil/BinaryHolder.h?rev=325769&r1=325768&r2=325769&view=diff
==============================================================================
--- llvm/trunk/tools/dsymutil/BinaryHolder.h (original)
+++ llvm/trunk/tools/dsymutil/BinaryHolder.h Thu Feb 22 03:43:43 2018
@@ -26,17 +26,15 @@
namespace llvm {
namespace dsymutil {
-/// \brief The BinaryHolder class is responsible for creating and
-/// owning ObjectFile objects and their underlying MemoryBuffer. This
-/// is different from a simple OwningBinary in that it handles
-/// accessing to archive members.
+/// The BinaryHolder class is responsible for creating and owning ObjectFile
+/// objects and their underlying MemoryBuffer. This is different from a simple
+/// OwningBinary in that it handles accessing to archive members.
///
-/// As an optimization, this class will reuse an already mapped and
-/// parsed Archive object if 2 successive requests target the same
-/// archive file (Which is always the case in debug maps).
-/// Currently it only owns one memory buffer at any given time,
-/// meaning that a mapping request will invalidate the previous memory
-/// mapping.
+/// As an optimization, this class will reuse an already mapped and parsed
+/// Archive object if 2 successive requests target the same archive file (Which
+/// is always the case in debug maps).
+/// Currently it only owns one memory buffer at any given time, meaning that a
+/// mapping request will invalidate the previous memory mapping.
class BinaryHolder {
std::vector<std::unique_ptr<object::Archive>> CurrentArchives;
std::unique_ptr<MemoryBuffer> CurrentMemoryBuffer;
Modified: llvm/trunk/tools/dsymutil/DebugMap.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/dsymutil/DebugMap.h?rev=325769&r1=325768&r2=325769&view=diff
==============================================================================
--- llvm/trunk/tools/dsymutil/DebugMap.h (original)
+++ llvm/trunk/tools/dsymutil/DebugMap.h Thu Feb 22 03:43:43 2018
@@ -48,10 +48,9 @@ namespace dsymutil {
class DebugMapObject;
-/// \brief The DebugMap object stores the list of object files to
-/// query for debug information along with the mapping between the
-/// symbols' addresses in the object file to their linked address in
-/// the linked binary.
+/// The DebugMap object stores the list of object files to query for debug
+/// information along with the mapping between the symbols' addresses in the
+/// object file to their linked address in the linked binary.
///
/// A DebugMap producer could look like this:
/// DebugMap *DM = new DebugMap();
@@ -125,10 +124,9 @@ public:
parseYAMLDebugMap(StringRef InputFile, StringRef PrependPath, bool Verbose);
};
-/// \brief The DebugMapObject represents one object file described by
-/// the DebugMap. It contains a list of mappings between addresses in
-/// the object file and in the linked binary for all the linked atoms
-/// in this object file.
+/// The DebugMapObject represents one object file described by the DebugMap. It
+/// contains a list of mappings between addresses in the object file and in the
+/// linked binary for all the linked atoms in this object file.
class DebugMapObject {
public:
struct SymbolMapping {
@@ -150,17 +148,17 @@ public:
using YAMLSymbolMapping = std::pair<std::string, SymbolMapping>;
using DebugMapEntry = StringMapEntry<SymbolMapping>;
- /// \brief Adds a symbol mapping to this DebugMapObject.
+ /// Adds a symbol mapping to this DebugMapObject.
/// \returns false if the symbol was already registered. The request
/// is discarded in this case.
bool addSymbol(StringRef SymName, Optional<uint64_t> ObjectAddress,
uint64_t LinkedAddress, uint32_t Size);
- /// \brief Lookup a symbol mapping.
+ /// Lookup a symbol mapping.
/// \returns null if the symbol isn't found.
const DebugMapEntry *lookupSymbol(StringRef SymbolName) const;
- /// \brief Lookup an objectfile address.
+ /// Lookup an object file address.
/// \returns null if the address isn't found.
const DebugMapEntry *lookupObjectAddress(uint64_t Address) const;
Modified: llvm/trunk/tools/dsymutil/MachODebugMapParser.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/dsymutil/MachODebugMapParser.cpp?rev=325769&r1=325768&r2=325769&view=diff
==============================================================================
--- llvm/trunk/tools/dsymutil/MachODebugMapParser.cpp (original)
+++ llvm/trunk/tools/dsymutil/MachODebugMapParser.cpp Thu Feb 22 03:43:43 2018
@@ -27,9 +27,8 @@ public:
PathPrefix(PathPrefix), MainBinaryHolder(Verbose),
CurrentObjectHolder(Verbose), CurrentDebugMapObject(nullptr) {}
- /// \brief Parses and returns the DebugMaps of the input binary.
- /// The binary contains multiple maps in case it is a universal
- /// binary.
+ /// Parses and returns the DebugMaps of the input binary. The binary contains
+ /// multiple maps in case it is a universal binary.
/// \returns an error in case the provided BinaryPath doesn't exist
/// or isn't of a supported type.
ErrorOr<std::vector<std::unique_ptr<DebugMap>>> parse();
Modified: llvm/trunk/tools/dsymutil/dsymutil.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/dsymutil/dsymutil.h?rev=325769&r1=325768&r2=325769&view=diff
==============================================================================
--- llvm/trunk/tools/dsymutil/dsymutil.h (original)
+++ llvm/trunk/tools/dsymutil/dsymutil.h Thu Feb 22 03:43:43 2018
@@ -54,20 +54,19 @@ struct LinkOptions {
LinkOptions() = default;
};
-/// \brief Extract the DebugMaps from the given file.
+/// Extract the DebugMaps from the given file.
/// The file has to be a MachO object file. Multiple debug maps can be
/// returned when the file is universal (aka fat) binary.
ErrorOr<std::vector<std::unique_ptr<DebugMap>>>
parseDebugMap(StringRef InputFile, ArrayRef<std::string> Archs,
StringRef PrependPath, bool Verbose, bool InputIsYAML);
-/// \brief Dump the symbol table
+/// Dump the symbol table
bool dumpStab(StringRef InputFile, ArrayRef<std::string> Archs,
StringRef PrependPath = "");
-/// \brief Link the Dwarf debug info as directed by the passed DebugMap
-/// \p DM into a DwarfFile named \p OutputFilename.
-/// \returns false if the link failed.
+/// Link the Dwarf debug info as directed by the passed DebugMap \p DM into a
+/// DwarfFile named \p OutputFilename. \returns false if the link failed.
bool linkDwarf(raw_fd_ostream &OutFile, const DebugMap &DM,
const LinkOptions &Options);