Jonas Devlieghere 8b3af63b89 [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
2019-04-10 20:48:55 +00:00

87 lines
2.0 KiB
C++

//===-- SBSymbol.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
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_SBSymbol_h_
#define LLDB_SBSymbol_h_
#include "lldb/API/SBAddress.h"
#include "lldb/API/SBDefines.h"
#include "lldb/API/SBInstructionList.h"
#include "lldb/API/SBTarget.h"
namespace lldb {
class LLDB_API SBSymbol {
public:
SBSymbol();
~SBSymbol();
SBSymbol(const lldb::SBSymbol &rhs);
const lldb::SBSymbol &operator=(const lldb::SBSymbol &rhs);
explicit operator bool() const;
bool IsValid() const;
const char *GetName() const;
const char *GetDisplayName() const;
const char *GetMangledName() const;
lldb::SBInstructionList GetInstructions(lldb::SBTarget target);
lldb::SBInstructionList GetInstructions(lldb::SBTarget target,
const char *flavor_string);
SBAddress GetStartAddress();
SBAddress GetEndAddress();
uint32_t GetPrologueByteSize();
SymbolType GetType();
bool operator==(const lldb::SBSymbol &rhs) const;
bool operator!=(const lldb::SBSymbol &rhs) const;
bool GetDescription(lldb::SBStream &description);
// Returns true if the symbol is externally visible in the module that it is
// defined in
bool IsExternal();
// Returns true if the symbol was synthetically generated from something
// other than the actual symbol table itself in the object file.
bool IsSynthetic();
protected:
lldb_private::Symbol *get();
void reset(lldb_private::Symbol *);
private:
friend class SBAddress;
friend class SBFrame;
friend class SBModule;
friend class SBSymbolContext;
SBSymbol(lldb_private::Symbol *lldb_object_ptr);
void SetSymbol(lldb_private::Symbol *lldb_object_ptr);
lldb_private::Symbol *m_opaque_ptr;
};
} // namespace lldb
#endif // LLDB_SBSymbol_h_