[PATCH] D66209: Improved the doc comment for getCommentsInFile

[Dmitri Gribenko via Phabricator via cfe-commits]

gribozavr created this revision.
Herald added a project: clang.
Herald added a subscriber: cfe-commits.
gribozavr added a reviewer: hokein.
hokein accepted this revision.
hokein added a comment.
This revision is now accepted and ready to land.

thanks!


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D66209

Files:
  clang/include/clang/AST/RawCommentList.h


Index: clang/include/clang/AST/RawCommentList.h
===================================================================
--- clang/include/clang/AST/RawCommentList.h
+++ clang/include/clang/AST/RawCommentList.h
@@ -199,7 +199,8 @@
   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 in \p File.
   const std::map<unsigned, RawComment *> *getCommentsInFile(FileID File) const;
 
   bool empty() const;


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D66209.215076.patch
Type: text/x-patch
Size: 689 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20190814/e9d81967/attachment-0001.bin>