Documentation cleanup: Doxygen-ification, typo fixes, and changing some of
the duplicated documentation from .cpp files so that it's not processed by Doxygen and hence doesn't generate duplicate output. llvm-svn: 195799
This commit is contained in:
parent
2d30ae2be9
commit
4a4f72d8d9
File diff suppressed because it is too large
Load Diff
|
@ -15,28 +15,28 @@
|
|||
#include "clang/Lex/Preprocessor.h"
|
||||
using namespace clang;
|
||||
|
||||
/// EnableBacktrackAtThisPos - From the point that this method is called, and
|
||||
/// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor
|
||||
/// keeps track of the lexed tokens so that a subsequent Backtrack() call will
|
||||
/// make the Preprocessor re-lex the same tokens.
|
||||
///
|
||||
/// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can
|
||||
/// be called multiple times and CommitBacktrackedTokens/Backtrack calls will
|
||||
/// be combined with the EnableBacktrackAtThisPos calls in reverse order.
|
||||
// EnableBacktrackAtThisPos - From the point that this method is called, and
|
||||
// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor
|
||||
// keeps track of the lexed tokens so that a subsequent Backtrack() call will
|
||||
// make the Preprocessor re-lex the same tokens.
|
||||
//
|
||||
// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can
|
||||
// be called multiple times and CommitBacktrackedTokens/Backtrack calls will
|
||||
// be combined with the EnableBacktrackAtThisPos calls in reverse order.
|
||||
void Preprocessor::EnableBacktrackAtThisPos() {
|
||||
BacktrackPositions.push_back(CachedLexPos);
|
||||
EnterCachingLexMode();
|
||||
}
|
||||
|
||||
/// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call.
|
||||
// Disable the last EnableBacktrackAtThisPos call.
|
||||
void Preprocessor::CommitBacktrackedTokens() {
|
||||
assert(!BacktrackPositions.empty()
|
||||
&& "EnableBacktrackAtThisPos was not called!");
|
||||
BacktrackPositions.pop_back();
|
||||
}
|
||||
|
||||
/// Backtrack - Make Preprocessor re-lex the tokens that were lexed since
|
||||
/// EnableBacktrackAtThisPos() was previously called.
|
||||
// Make Preprocessor re-lex the tokens that were lexed since
|
||||
// EnableBacktrackAtThisPos() was previously called.
|
||||
void Preprocessor::Backtrack() {
|
||||
assert(!BacktrackPositions.empty()
|
||||
&& "EnableBacktrackAtThisPos was not called!");
|
||||
|
@ -114,5 +114,4 @@ void Preprocessor::AnnotatePreviousCachedTokens(const Token &Tok) {
|
|||
CachedLexPos = i;
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
@ -1327,21 +1327,20 @@ bool Preprocessor::GetIncludeFilenameSpelling(SourceLocation Loc,
|
|||
return isAngled;
|
||||
}
|
||||
|
||||
/// \brief Handle cases where the \#include name is expanded from a macro
|
||||
/// as multiple tokens, which need to be glued together.
|
||||
///
|
||||
/// This occurs for code like:
|
||||
/// \code
|
||||
/// \#define FOO <a/b.h>
|
||||
/// \#include FOO
|
||||
/// \endcode
|
||||
/// because in this case, "<a/b.h>" is returned as 7 tokens, not one.
|
||||
///
|
||||
/// This code concatenates and consumes tokens up to the '>' token. It returns
|
||||
/// false if the > was found, otherwise it returns true if it finds and consumes
|
||||
/// the EOD marker.
|
||||
bool Preprocessor::ConcatenateIncludeName(
|
||||
SmallString<128> &FilenameBuffer,
|
||||
// \brief Handle cases where the \#include name is expanded from a macro
|
||||
// as multiple tokens, which need to be glued together.
|
||||
//
|
||||
// This occurs for code like:
|
||||
// \code
|
||||
// \#define FOO <a/b.h>
|
||||
// \#include FOO
|
||||
// \endcode
|
||||
// because in this case, "<a/b.h>" is returned as 7 tokens, not one.
|
||||
//
|
||||
// This code concatenates and consumes tokens up to the '>' token. It returns
|
||||
// false if the > was found, otherwise it returns true if it finds and consumes
|
||||
// the EOD marker.
|
||||
bool Preprocessor::ConcatenateIncludeName(SmallString<128> &FilenameBuffer,
|
||||
SourceLocation &End) {
|
||||
Token CurTok;
|
||||
|
||||
|
|
Loading…
Reference in New Issue