From: Dmitri Gribenko <gribozavr@gmail.com>
Date: Wed, 14 Aug 2019 11:11:52 +0000 (+0000)
Subject: Improved the doc comment for getCommentsInFile
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bbb91ec82191697aa8f2664c4498928cd78a81db;p=clang

Improved the doc comment for getCommentsInFile

Subscribers: cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D66209

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@368827 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/clang/AST/RawCommentList.h b/include/clang/AST/RawCommentList.h
index 813e1ed7dd..1eea56dee6 100644
--- a/include/clang/AST/RawCommentList.h
+++ b/include/clang/AST/RawCommentList.h
@@ -199,7 +199,8 @@ public:
   void addComment(const RawComment &RC, const CommentOptions &CommentOpts,
                   llvm::BumpPtrAllocator &Allocator);
 
-  /// \returns nullptr in case there are no comments in in \p File.
+  /// \returns A mapping from an offset of the start of the comment to the
+  /// comment itself, or nullptr in case there are no comments in \p File.
   const std::map<unsigned, RawComment *> *getCommentsInFile(FileID File) const;
 
   bool empty() const;