diff options
Diffstat (limited to 'include/llvm/Support/LineIterator.h')
-rw-r--r-- | include/llvm/Support/LineIterator.h | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/include/llvm/Support/LineIterator.h b/include/llvm/Support/LineIterator.h index 9d4cd3bd4c6d..892d289976cb 100644 --- a/include/llvm/Support/LineIterator.h +++ b/include/llvm/Support/LineIterator.h @@ -18,7 +18,7 @@ namespace llvm { class MemoryBuffer; -/// \brief A forward iterator which reads text lines from a buffer. +/// A forward iterator which reads text lines from a buffer. /// /// This class provides a forward iterator interface for reading one line at /// a time from a buffer. When default constructed the iterator will be the @@ -39,23 +39,23 @@ class line_iterator StringRef CurrentLine; public: - /// \brief Default construct an "end" iterator. + /// Default construct an "end" iterator. line_iterator() : Buffer(nullptr) {} - /// \brief Construct a new iterator around some memory buffer. + /// Construct a new iterator around some memory buffer. explicit line_iterator(const MemoryBuffer &Buffer, bool SkipBlanks = true, char CommentMarker = '\0'); - /// \brief Return true if we've reached EOF or are an "end" iterator. + /// Return true if we've reached EOF or are an "end" iterator. bool is_at_eof() const { return !Buffer; } - /// \brief Return true if we're an "end" iterator or have reached EOF. + /// Return true if we're an "end" iterator or have reached EOF. bool is_at_end() const { return is_at_eof(); } - /// \brief Return the current line number. May return any number at EOF. + /// Return the current line number. May return any number at EOF. int64_t line_number() const { return LineNumber; } - /// \brief Advance to the next (non-empty, non-comment) line. + /// Advance to the next (non-empty, non-comment) line. line_iterator &operator++() { advance(); return *this; @@ -66,7 +66,7 @@ public: return tmp; } - /// \brief Get the current line as a \c StringRef. + /// Get the current line as a \c StringRef. StringRef operator*() const { return CurrentLine; } const StringRef *operator->() const { return &CurrentLine; } @@ -80,7 +80,7 @@ public: } private: - /// \brief Advance the iterator to the next line. + /// Advance the iterator to the next line. void advance(); }; } |