[NFC] Remove ASCII lines from comments

A lot of comments in LLDB are surrounded by an ASCII line to delimit the
begging and end of the comment.

Its use is not really consistent across the code base, sometimes the
lines are longer, sometimes they are shorter and sometimes they are
omitted. Furthermore, it looks kind of weird with the 80 column limit,
where the comment actually extends past the line, but not by much.
Furthermore, when /// is used for Doxygen comments, it looks
particularly odd. And when // is used, it incorrectly gives the
impression that it's actually a Doxygen comment.

I assume these lines were added to improve distinguishing between
comments and code. However, given that todays editors and IDEs do a
great job at highlighting comments, I think it's worth to drop this for
the sake of consistency. The alternative is fixing all the
inconsistencies, which would create a lot more churn.

Differential revision: https://reviews.llvm.org/D60508

llvm-svn: 358135

4 files changed, 0 insertions, 74 deletions

diff --git a/lldb/source/Plugins/ObjectFile/ELF/ELFHeader.cpp b/lldb/source/Plugins/ObjectFile/ELF/ELFHeader.cpp
index 13d85d1c95b..7f9665af9a3 100644
--- a/lldb/source/Plugins/ObjectFile/ELF/ELFHeader.cpp
+++ b/lldb/source/Plugins/ObjectFile/ELF/ELFHeader.cpp
@@ -18,7 +18,6 @@ using namespace elf;
 using namespace lldb;
 using namespace llvm::ELF;
 
-//------------------------------------------------------------------------------
 // Static utility functions.
 //
 // GetMaxU64 and GetMaxS64 wrap the similarly named methods from DataExtractor
@@ -67,7 +66,6 @@ static bool GetMaxS64(const lldb_private::DataExtractor &data,
   return true;
 }
 
-//------------------------------------------------------------------------------
 // ELFHeader
 
 ELFHeader::ELFHeader() { memset(this, 0, sizeof(ELFHeader)); }
@@ -215,7 +213,6 @@ unsigned ELFHeader::GetRelocationJumpSlotType() const {
   return slot;
 }
 
-//------------------------------------------------------------------------------
 // ELFSectionHeader
 
 ELFSectionHeader::ELFSectionHeader() {
@@ -249,7 +246,6 @@ bool ELFSectionHeader::Parse(const lldb_private::DataExtractor &data,
   return true;
 }
 
-//------------------------------------------------------------------------------
 // ELFSymbol
 
 ELFSymbol::ELFSymbol() { memset(this, 0, sizeof(ELFSymbol)); }
@@ -357,7 +353,6 @@ bool ELFSymbol::Parse(const lldb_private::DataExtractor &data,
   return true;
 }
 
-//------------------------------------------------------------------------------
 // ELFProgramHeader
 
 ELFProgramHeader::ELFProgramHeader() {
@@ -398,7 +393,6 @@ bool ELFProgramHeader::Parse(const lldb_private::DataExtractor &data,
   return true;
 }
 
-//------------------------------------------------------------------------------
 // ELFDynamic
 
 ELFDynamic::ELFDynamic() { memset(this, 0, sizeof(ELFDynamic)); }
@@ -409,7 +403,6 @@ bool ELFDynamic::Parse(const lldb_private::DataExtractor &data,
   return GetMaxS64(data, offset, &d_tag, byte_size, 2);
 }
 
-//------------------------------------------------------------------------------
 // ELFRel
 
 ELFRel::ELFRel() { memset(this, 0, sizeof(ELFRel)); }
@@ -422,7 +415,6 @@ bool ELFRel::Parse(const lldb_private::DataExtractor &data,
   return GetMaxU64(data, offset, &r_offset, byte_size, 2) != false;
 }
 
-//------------------------------------------------------------------------------
 // ELFRela
 
 ELFRela::ELFRela() { memset(this, 0, sizeof(ELFRela)); }
diff --git a/lldb/source/Plugins/ObjectFile/ELF/ELFHeader.h b/lldb/source/Plugins/ObjectFile/ELF/ELFHeader.h
index 2a2b13243fe..bb228e269d4 100644
--- a/lldb/source/Plugins/ObjectFile/ELF/ELFHeader.h
+++ b/lldb/source/Plugins/ObjectFile/ELF/ELFHeader.h
@@ -31,7 +31,6 @@ class DataExtractor;
 
 namespace elf {
 
-//------------------------------------------------------------------------------
 /// \name ELF type definitions.
 ///
 /// Types used to represent the various components of ELF structures.  All
@@ -49,7 +48,6 @@ typedef uint64_t elf_xword;
 typedef int64_t elf_sxword;
 //@}
 
-//------------------------------------------------------------------------------
 /// \class ELFHeader
 /// Generic representation of an ELF file header.
 ///
@@ -80,7 +78,6 @@ struct ELFHeader {
 
   ELFHeader();
 
-  //--------------------------------------------------------------------------
   /// Returns true if this is a 32 bit ELF file header.
   ///
   /// \return
@@ -89,7 +86,6 @@ struct ELFHeader {
     return e_ident[llvm::ELF::EI_CLASS] == llvm::ELF::ELFCLASS32;
   }
 
-  //--------------------------------------------------------------------------
   /// Returns true if this is a 64 bit ELF file header.
   ///
   /// \return
@@ -98,18 +94,15 @@ struct ELFHeader {
     return e_ident[llvm::ELF::EI_CLASS] == llvm::ELF::ELFCLASS64;
   }
 
-  //--------------------------------------------------------------------------
   /// The byte order of this ELF file header.
   ///
   /// \return
   ///    The byte order of this ELF file as described by the header.
   lldb::ByteOrder GetByteOrder() const;
 
-  //--------------------------------------------------------------------------
   /// The jump slot relocation type of this ELF.
   unsigned GetRelocationJumpSlotType() const;
 
-  //--------------------------------------------------------------------------
   /// Check if there should be header extension in section header #0
   ///
   /// \return
@@ -117,7 +110,6 @@ struct ELFHeader {
   ///    and false otherwise.
   bool HasHeaderExtension() const;
 
-  //--------------------------------------------------------------------------
   /// Parse an ELFHeader entry starting at position \p offset and update the
   /// data extractor with the address size and byte order attributes as
   /// defined by the header.
@@ -135,7 +127,6 @@ struct ELFHeader {
   ///    otherwise.
   bool Parse(lldb_private::DataExtractor &data, lldb::offset_t *offset);
 
-  //--------------------------------------------------------------------------
   /// Examines at most EI_NIDENT bytes starting from the given pointer and
   /// determines if the magic ELF identification exists.
   ///
@@ -143,7 +134,6 @@ struct ELFHeader {
   ///    True if the given sequence of bytes identifies an ELF file.
   static bool MagicBytesMatch(const uint8_t *magic);
 
-  //--------------------------------------------------------------------------
   /// Examines at most EI_NIDENT bytes starting from the given address and
   /// determines the address size of the underlying ELF file.  This function
   /// should only be called on an pointer for which MagicBytesMatch returns
@@ -156,7 +146,6 @@ struct ELFHeader {
 
 private:
 
-  //--------------------------------------------------------------------------
   /// Parse an ELFHeader header extension entry.  This method is called by
   /// Parse().
   ///
@@ -165,7 +154,6 @@ private:
   void ParseHeaderExtension(lldb_private::DataExtractor &data);
 };
 
-//------------------------------------------------------------------------------
 /// \class ELFSectionHeader
 /// Generic representation of an ELF section header.
 struct ELFSectionHeader {
@@ -182,7 +170,6 @@ struct ELFSectionHeader {
 
   ELFSectionHeader();
 
-  //--------------------------------------------------------------------------
   /// Parse an ELFSectionHeader entry from the given DataExtracter starting at
   /// position \p offset.
   ///
@@ -200,7 +187,6 @@ struct ELFSectionHeader {
   bool Parse(const lldb_private::DataExtractor &data, lldb::offset_t *offset);
 };
 
-//------------------------------------------------------------------------------
 /// \class ELFProgramHeader
 /// Generic representation of an ELF program header.
 struct ELFProgramHeader {
@@ -233,7 +219,6 @@ struct ELFProgramHeader {
   bool Parse(const lldb_private::DataExtractor &data, lldb::offset_t *offset);
 };
 
-//------------------------------------------------------------------------------
 /// \class ELFSymbol
 /// Represents a symbol within an ELF symbol table.
 struct ELFSymbol {
@@ -286,7 +271,6 @@ struct ELFSymbol {
             const lldb_private::SectionList *section_list);
 };
 
-//------------------------------------------------------------------------------
 /// \class ELFDynamic
 /// Represents an entry in an ELF dynamic table.
 struct ELFDynamic {
@@ -316,7 +300,6 @@ struct ELFDynamic {
   bool Parse(const lldb_private::DataExtractor &data, lldb::offset_t *offset);
 };
 
-//------------------------------------------------------------------------------
 /// \class ELFRel
 /// Represents a relocation entry with an implicit addend.
 struct ELFRel {
@@ -358,7 +341,6 @@ struct ELFRel {
   static unsigned RelocSymbol64(const ELFRel &rel) { return rel.r_info >> 32; }
 };
 
-//------------------------------------------------------------------------------
 /// \class ELFRela
 /// Represents a relocation entry with an explicit addend.
 struct ELFRela {
diff --git a/lldb/source/Plugins/ObjectFile/ELF/ObjectFileELF.cpp b/lldb/source/Plugins/ObjectFile/ELF/ObjectFileELF.cpp
index d3a78239427..ac9642b2968 100644
--- a/lldb/source/Plugins/ObjectFile/ELF/ObjectFileELF.cpp
+++ b/lldb/source/Plugins/ObjectFile/ELF/ObjectFileELF.cpp
@@ -336,9 +336,7 @@ static uint32_t subTypeFromElfHeader(const elf::ELFHeader &header) {
 // Arbitrary constant used as UUID prefix for core files.
 const uint32_t ObjectFileELF::g_core_uuid_magic(0xE210C);
 
-//------------------------------------------------------------------
 // Static methods.
-//------------------------------------------------------------------
 void ObjectFileELF::Initialize() {
   PluginManager::RegisterPlugin(GetPluginNameStatic(),
                                 GetPluginDescriptionStatic(), CreateInstance,
@@ -711,17 +709,13 @@ size_t ObjectFileELF::GetModuleSpecifications(
   return specs.GetSize() - initial_count;
 }
 
-//------------------------------------------------------------------
 // PluginInterface protocol
-//------------------------------------------------------------------
 lldb_private::ConstString ObjectFileELF::GetPluginName() {
   return GetPluginNameStatic();
 }
 
 uint32_t ObjectFileELF::GetPluginVersion() { return m_plugin_version; }
-//------------------------------------------------------------------
 // ObjectFile protocol
-//------------------------------------------------------------------
 
 ObjectFileELF::ObjectFileELF(const lldb::ModuleSP &module_sp,
                              DataBufferSP &data_sp, lldb::offset_t data_offset,
@@ -1009,9 +1003,7 @@ Address ObjectFileELF::GetBaseAddress() {
   return LLDB_INVALID_ADDRESS;
 }
 
-//----------------------------------------------------------------------
 // ParseDependentModules
-//----------------------------------------------------------------------
 size_t ObjectFileELF::ParseDependentModules() {
   if (m_filespec_up)
     return m_filespec_up->GetSize();
@@ -1070,9 +1062,7 @@ size_t ObjectFileELF::ParseDependentModules() {
   return m_filespec_up->GetSize();
 }
 
-//----------------------------------------------------------------------
 // GetProgramHeaderInfo
-//----------------------------------------------------------------------
 size_t ObjectFileELF::GetProgramHeaderInfo(ProgramHeaderColl &program_headers,
                                            DataExtractor &object_data,
                                            const ELFHeader &header) {
@@ -1107,9 +1097,7 @@ size_t ObjectFileELF::GetProgramHeaderInfo(ProgramHeaderColl &program_headers,
   return program_headers.size();
 }
 
-//----------------------------------------------------------------------
 // ParseProgramHeaders
-//----------------------------------------------------------------------
 bool ObjectFileELF::ParseProgramHeaders() {
   return GetProgramHeaderInfo(m_program_headers, m_data, m_header) != 0;
 }
@@ -1302,8 +1290,6 @@ ObjectFileELF::RefineModuleDetailsFromNote(lldb_private::DataExtractor &data,
       // the contents look like this in a 64 bit ELF core file: count     =
       // 0x000000000000000a (10) page_size = 0x0000000000001000 (4096) Index
       // start              end                file_ofs           path =====
-      // ------------------ ------------------ ------------------
-      // ------------------------------------- [  0] 0x0000000000400000
       // 0x0000000000401000 0x0000000000000000 /tmp/a.out [  1]
       // 0x0000000000600000 0x0000000000601000 0x0000000000000000 /tmp/a.out [
       // 2] 0x0000000000601000 0x0000000000602000 0x0000000000000001 /tmp/a.out
@@ -1427,9 +1413,7 @@ void ObjectFileELF::ParseARMAttributes(DataExtractor &data, uint64_t length,
   }
 }
 
-//----------------------------------------------------------------------
 // GetSectionHeaderInfo
-//----------------------------------------------------------------------
 size_t ObjectFileELF::GetSectionHeaderInfo(SectionHeaderColl &section_headers,
                                            DataExtractor &object_data,
                                            const elf::ELFHeader &header,
@@ -1662,9 +1646,7 @@ ObjectFileELF::StripLinkerSymbolAnnotations(llvm::StringRef symbol_name) const {
   return symbol_name.substr(0, pos);
 }
 
-//----------------------------------------------------------------------
 // ParseSectionHeaders
-//----------------------------------------------------------------------
 size_t ObjectFileELF::ParseSectionHeaders() {
   return GetSectionHeaderInfo(m_section_headers, m_data, m_header, m_uuid,
                               m_gnu_debuglink_file, m_gnu_debuglink_crc,
@@ -2932,7 +2914,6 @@ bool ObjectFileELF::IsStripped() {
 //
 // Dump the specifics of the runtime file container (such as any headers
 // segments, sections, etc).
-//----------------------------------------------------------------------
 void ObjectFileELF::Dump(Stream *s) {
   ModuleSP module_sp(GetModule());
   if (!module_sp) {
@@ -2966,11 +2947,9 @@ void ObjectFileELF::Dump(Stream *s) {
   s->EOL();
 }
 
-//----------------------------------------------------------------------
 // DumpELFHeader
 //
 // Dump the ELF header to the specified output stream
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFHeader(Stream *s, const ELFHeader &header) {
   s->PutCString("ELF Header\n");
   s->Printf("e_ident[EI_MAG0   ] = 0x%2.2x\n", header.e_ident[EI_MAG0]);
@@ -3003,11 +2982,9 @@ void ObjectFileELF::DumpELFHeader(Stream *s, const ELFHeader &header) {
   s->Printf("e_shstrndx  = 0x%8.8x\n", header.e_shstrndx);
 }
 
-//----------------------------------------------------------------------
 // DumpELFHeader_e_type
 //
 // Dump an token value for the ELF header member e_type
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFHeader_e_type(Stream *s, elf_half e_type) {
   switch (e_type) {
   case ET_NONE:
@@ -3030,11 +3007,9 @@ void ObjectFileELF::DumpELFHeader_e_type(Stream *s, elf_half e_type) {
   }
 }
 
-//----------------------------------------------------------------------
 // DumpELFHeader_e_ident_EI_DATA
 //
 // Dump an token value for the ELF header member e_ident[EI_DATA]
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFHeader_e_ident_EI_DATA(Stream *s,
                                                   unsigned char ei_data) {
   switch (ei_data) {
@@ -3052,11 +3027,9 @@ void ObjectFileELF::DumpELFHeader_e_ident_EI_DATA(Stream *s,
   }
 }
 
-//----------------------------------------------------------------------
 // DumpELFProgramHeader
 //
 // Dump a single ELF program header to the specified output stream
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFProgramHeader(Stream *s,
                                          const ELFProgramHeader &ph) {
   DumpELFProgramHeader_p_type(s, ph.p_type);
@@ -3069,12 +3042,10 @@ void ObjectFileELF::DumpELFProgramHeader(Stream *s,
   s->Printf(") %8.8" PRIx64, ph.p_align);
 }
 
-//----------------------------------------------------------------------
 // DumpELFProgramHeader_p_type
 //
 // Dump an token value for the ELF program header member p_type which describes
 // the type of the program header
-// ----------------------------------------------------------------------
 void ObjectFileELF::DumpELFProgramHeader_p_type(Stream *s, elf_word p_type) {
   const int kStrWidth = 15;
   switch (p_type) {
@@ -3093,11 +3064,9 @@ void ObjectFileELF::DumpELFProgramHeader_p_type(Stream *s, elf_word p_type) {
   }
 }
 
-//----------------------------------------------------------------------
 // DumpELFProgramHeader_p_flags
 //
 // Dump an token value for the ELF program header member p_flags
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFProgramHeader_p_flags(Stream *s, elf_word p_flags) {
   *s << ((p_flags & PF_X) ? "PF_X" : "    ")
      << (((p_flags & PF_X) && (p_flags & PF_W)) ? '+' : ' ')
@@ -3106,11 +3075,9 @@ void ObjectFileELF::DumpELFProgramHeader_p_flags(Stream *s, elf_word p_flags) {
      << ((p_flags & PF_R) ? "PF_R" : "    ");
 }
 
-//----------------------------------------------------------------------
 // DumpELFProgramHeaders
 //
 // Dump all of the ELF program header to the specified output stream
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFProgramHeaders(Stream *s) {
   if (!ParseProgramHeaders())
     return;
@@ -3128,11 +3095,9 @@ void ObjectFileELF::DumpELFProgramHeaders(Stream *s) {
   }
 }
 
-//----------------------------------------------------------------------
 // DumpELFSectionHeader
 //
 // Dump a single ELF section header to the specified output stream
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFSectionHeader(Stream *s,
                                          const ELFSectionHeaderInfo &sh) {
   s->Printf("%8.8x ", sh.sh_name);
@@ -3145,12 +3110,10 @@ void ObjectFileELF::DumpELFSectionHeader(Stream *s,
   s->Printf(" %8.8" PRIx64 " %8.8" PRIx64, sh.sh_addralign, sh.sh_entsize);
 }
 
-//----------------------------------------------------------------------
 // DumpELFSectionHeader_sh_type
 //
 // Dump an token value for the ELF section header member sh_type which
 // describes the type of the section
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFSectionHeader_sh_type(Stream *s, elf_word sh_type) {
   const int kStrWidth = 12;
   switch (sh_type) {
@@ -3176,11 +3139,9 @@ void ObjectFileELF::DumpELFSectionHeader_sh_type(Stream *s, elf_word sh_type) {
   }
 }
 
-//----------------------------------------------------------------------
 // DumpELFSectionHeader_sh_flags
 //
 // Dump an token value for the ELF section header member sh_flags
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFSectionHeader_sh_flags(Stream *s,
                                                   elf_xword sh_flags) {
   *s << ((sh_flags & SHF_WRITE) ? "WRITE" : "     ")
@@ -3190,11 +3151,9 @@ void ObjectFileELF::DumpELFSectionHeader_sh_flags(Stream *s,
      << ((sh_flags & SHF_EXECINSTR) ? "EXECINSTR" : "         ");
 }
 
-//----------------------------------------------------------------------
 // DumpELFSectionHeaders
 //
 // Dump all of the ELF section header to the specified output stream
-//----------------------------------------------------------------------
 void ObjectFileELF::DumpELFSectionHeaders(Stream *s) {
   if (!ParseSectionHeaders())
     return;
diff --git a/lldb/source/Plugins/ObjectFile/ELF/ObjectFileELF.h b/lldb/source/Plugins/ObjectFile/ELF/ObjectFileELF.h
index b11a4bdbe17..b63a5d14d4f 100644
--- a/lldb/source/Plugins/ObjectFile/ELF/ObjectFileELF.h
+++ b/lldb/source/Plugins/ObjectFile/ELF/ObjectFileELF.h
@@ -49,7 +49,6 @@ struct ELFNote {
   }
 };
 
-//------------------------------------------------------------------------------
 /// \class ObjectFileELF
 /// Generic ELF object file reader.
 ///
@@ -59,9 +58,7 @@ class ObjectFileELF : public lldb_private::ObjectFile {
 public:
   ~ObjectFileELF() override;
 
-  //------------------------------------------------------------------
   // Static Functions
-  //------------------------------------------------------------------
   static void Initialize();
 
   static void Terminate();
@@ -89,16 +86,12 @@ public:
   static bool MagicBytesMatch(lldb::DataBufferSP &data_sp, lldb::addr_t offset,
                               lldb::addr_t length);
 
-  //------------------------------------------------------------------
   // PluginInterface protocol
-  //------------------------------------------------------------------
   lldb_private::ConstString GetPluginName() override;
 
   uint32_t GetPluginVersion() override;
 
-  //------------------------------------------------------------------
   // ObjectFile Protocol.
-  //------------------------------------------------------------------
   bool ParseHeader() override;
 
   bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value,