[llvm] r211086 - Modernize doc comments for SourceMgr.
Jordan Rose
jordan_rose at apple.com
Mon Jun 16 19:15:36 PDT 2014
Author: jrose
Date: Mon Jun 16 21:15:36 2014
New Revision: 211086
URL: http://llvm.org/viewvc/llvm-project?rev=211086&view=rev
Log:
Modernize doc comments for SourceMgr.
No functionality change.
Modified:
llvm/trunk/include/llvm/Support/SourceMgr.h
llvm/trunk/lib/Support/SourceMgr.cpp
Modified: llvm/trunk/include/llvm/Support/SourceMgr.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/SourceMgr.h?rev=211086&r1=211085&r2=211086&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/SourceMgr.h (original)
+++ llvm/trunk/include/llvm/Support/SourceMgr.h Mon Jun 16 21:15:36 2014
@@ -30,7 +30,7 @@ namespace llvm {
class Twine;
class raw_ostream;
-/// SourceMgr - This owns the files read by a parser, handles include stacks,
+/// This owns the files read by a parser, handles include stacks,
/// and handles diagnostic wrangling.
class SourceMgr {
public:
@@ -40,29 +40,27 @@ public:
DK_Note
};
- /// DiagHandlerTy - Clients that want to handle their own diagnostics in a
- /// custom way can register a function pointer+context as a diagnostic
- /// handler. It gets called each time PrintMessage is invoked.
+ /// Clients that want to handle their own diagnostics in a custom way can
+ /// register a function pointer+context as a diagnostic handler.
+ /// It gets called each time PrintMessage is invoked.
typedef void (*DiagHandlerTy)(const SMDiagnostic &, void *Context);
private:
struct SrcBuffer {
- /// Buffer - The memory buffer for the file.
+ /// The memory buffer for the file.
MemoryBuffer *Buffer;
- /// IncludeLoc - This is the location of the parent include, or null if at
- /// the top level.
+ /// This is the location of the parent include, or null if at the top level.
SMLoc IncludeLoc;
};
- /// Buffers - This is all of the buffers that we are reading from.
+ /// This is all of the buffers that we are reading from.
std::vector<SrcBuffer> Buffers;
- // IncludeDirectories - This is the list of directories we should search for
- // include files in.
+ // This is the list of directories we should search for include files in.
std::vector<std::string> IncludeDirectories;
- /// LineNoCache - This is a cache for line number queries, its implementation
- /// is really private to SourceMgr.cpp.
+ /// This is a cache for line number queries, its implementation is really
+ /// private to SourceMgr.cpp.
mutable void *LineNoCache;
DiagHandlerTy DiagHandler;
@@ -79,8 +77,8 @@ public:
IncludeDirectories = Dirs;
}
- /// setDiagHandler - Specify a diagnostic handler to be invoked every time
- /// PrintMessage is called. Ctx is passed into the handler when it is invoked.
+ /// Specify a diagnostic handler to be invoked every time PrintMessage is
+ /// called. \p Ctx is passed into the handler when it is invoked.
void setDiagHandler(DiagHandlerTy DH, void *Ctx = nullptr) {
DiagHandler = DH;
DiagContext = Ctx;
@@ -108,8 +106,8 @@ public:
return Buffers[i].IncludeLoc;
}
- /// AddNewSourceBuffer - Add a new source buffer to this source manager. This
- /// takes ownership of the memory buffer.
+ /// Add a new source buffer to this source manager. This takes ownership of
+ /// the memory buffer.
size_t AddNewSourceBuffer(MemoryBuffer *F, SMLoc IncludeLoc) {
SrcBuffer NB;
NB.Buffer = F;
@@ -118,32 +116,34 @@ public:
return Buffers.size() - 1;
}
- /// AddIncludeFile - Search for a file with the specified name in the current
- /// directory or in one of the IncludeDirs. If no file is found, this returns
- /// ~0, otherwise it returns the buffer ID of the stacked file.
- /// The full path to the included file can be found in IncludedFile.
+ /// Search for a file with the specified name in the current directory or in
+ /// one of the IncludeDirs.
+ ///
+ /// If no file is found, this returns ~0, otherwise it returns the buffer ID
+ /// of the stacked file. The full path to the included file can be found in
+ /// \p IncludedFile.
size_t AddIncludeFile(const std::string &Filename, SMLoc IncludeLoc,
std::string &IncludedFile);
- /// FindBufferContainingLoc - Return the ID of the buffer containing the
- /// specified location, returning -1 if not found.
+ /// Return the ID of the buffer containing the specified location.
+ ///
+ /// -1 is returned if the buffer is not found.
int FindBufferContainingLoc(SMLoc Loc) const;
- /// FindLineNumber - Find the line number for the specified location in the
- /// specified file. This is not a fast method.
+ /// Find the line number for the specified location in the specified file.
+ /// This is not a fast method.
unsigned FindLineNumber(SMLoc Loc, int BufferID = -1) const {
return getLineAndColumn(Loc, BufferID).first;
}
- /// getLineAndColumn - Find the line and column number for the specified
- /// location in the specified file. This is not a fast method.
+ /// Find the line and column number for the specified location in the
+ /// specified file. This is not a fast method.
std::pair<unsigned, unsigned>
getLineAndColumn(SMLoc Loc, int BufferID = -1) const;
- /// PrintMessage - Emit a message about the specified location with the
- /// specified string.
+ /// Emit a message about the specified location with the specified string.
///
- /// @param ShowColors - Display colored messages if output is a terminal and
+ /// \param ShowColors Display colored messages if output is a terminal and
/// the default error handler is used.
void PrintMessage(raw_ostream &OS, SMLoc Loc, DiagKind Kind,
const Twine &Msg,
@@ -157,21 +157,21 @@ public:
ArrayRef<SMFixIt> FixIts = None,
bool ShowColors = true) const;
- /// GetMessage - Return an SMDiagnostic at the specified location with the
- /// specified string.
+ /// Return an SMDiagnostic at the specified location with the specified
+ /// string.
///
- /// @param Msg If non-null, the kind of message (e.g., "error") which is
+ /// \param Msg If non-null, the kind of message (e.g., "error") which is
/// prefixed to the message.
SMDiagnostic GetMessage(SMLoc Loc, DiagKind Kind, const Twine &Msg,
ArrayRef<SMRange> Ranges = None,
ArrayRef<SMFixIt> FixIts = None) const;
- /// PrintIncludeStack - Prints the names of included files and the line of the
- /// file they were included from. A diagnostic handler can use this before
- /// printing its custom formatted message.
+ /// Prints the names of included files and the line of the file they were
+ /// included from. A diagnostic handler can use this before printing its
+ /// custom formatted message.
///
- /// @param IncludeLoc - The line of the include.
- /// @param OS the raw_ostream to print on.
+ /// \param IncludeLoc The location of the include.
+ /// \param OS the raw_ostream to print on.
void PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const;
};
@@ -208,8 +208,8 @@ public:
};
-/// SMDiagnostic - Instances of this class encapsulate one diagnostic report,
-/// allowing printing to a raw_ostream as a caret diagnostic.
+/// Instances of this class encapsulate one diagnostic report, allowing
+/// printing to a raw_ostream as a caret diagnostic.
class SMDiagnostic {
const SourceMgr *SM;
SMLoc Loc;
Modified: llvm/trunk/lib/Support/SourceMgr.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Support/SourceMgr.cpp?rev=211086&r1=211085&r2=211086&view=diff
==============================================================================
--- llvm/trunk/lib/Support/SourceMgr.cpp (original)
+++ llvm/trunk/lib/Support/SourceMgr.cpp Mon Jun 16 21:15:36 2014
@@ -49,9 +49,6 @@ SourceMgr::~SourceMgr() {
}
}
-/// AddIncludeFile - Search for a file with the specified name in the current
-/// directory or in one of the IncludeDirs. If no file is found, this returns
-/// ~0, otherwise it returns the buffer ID of the stacked file.
size_t SourceMgr::AddIncludeFile(const std::string &Filename,
SMLoc IncludeLoc,
std::string &IncludedFile) {
@@ -71,8 +68,6 @@ size_t SourceMgr::AddIncludeFile(const s
}
-/// FindBufferContainingLoc - Return the ID of the buffer containing the
-/// specified location, returning -1 if not found.
int SourceMgr::FindBufferContainingLoc(SMLoc Loc) const {
for (unsigned i = 0, e = Buffers.size(); i != e; ++i)
if (Loc.getPointer() >= Buffers[i].Buffer->getBufferStart() &&
@@ -83,8 +78,6 @@ int SourceMgr::FindBufferContainingLoc(S
return -1;
}
-/// getLineAndColumn - Find the line and column number for the specified
-/// location in the specified file. This is not a fast method.
std::pair<unsigned, unsigned>
SourceMgr::getLineAndColumn(SMLoc Loc, int BufferID) const {
if (BufferID == -1) BufferID = FindBufferContainingLoc(Loc);
@@ -143,11 +136,6 @@ void SourceMgr::PrintIncludeStack(SMLoc
}
-/// GetMessage - Return an SMDiagnostic at the specified location with the
-/// specified string.
-///
-/// @param Type - If non-null, the kind of message (e.g., "error") which is
-/// prefixed to the message.
SMDiagnostic SourceMgr::GetMessage(SMLoc Loc, SourceMgr::DiagKind Kind,
const Twine &Msg,
ArrayRef<SMRange> Ranges,
More information about the llvm-commits
mailing list