[PATCH] D66209: Improved the doc comment for getCommentsInFile

[Dmitri Gribenko via Phabricator via cfe-commits]

This revision was automatically updated to reflect the committed changes.
Closed by commit rL368827: Improved the doc comment for getCommentsInFile (authored by gribozavr, committed by ).
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Changed prior to commit:
  https://reviews.llvm.org/D66209?vs=215076&id=215078#toc

Repository:
  rL LLVM

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D66209/new/

https://reviews.llvm.org/D66209

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


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


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