[llvm] 403d72c - [Support][NFC] Clarify function comment
Eric Li via llvm-commits
llvm-commits at lists.llvm.org
Tue Sep 20 08:12:52 PDT 2022
Author: Eric Li
Date: 2022-09-20T11:10:16-04:00
New Revision: 403d72cd43528d36db529cb0c4063be56a1097f5
URL: https://github.com/llvm/llvm-project/commit/403d72cd43528d36db529cb0c4063be56a1097f5
DIFF: https://github.com/llvm/llvm-project/commit/403d72cd43528d36db529cb0c4063be56a1097f5.diff
LOG: [Support][NFC] Clarify function comment
Follow-up to 86118ec2 that addresses the comments in D134072, which
were accidentally left off of the commit.
Added:
Modified:
llvm/include/llvm/Testing/Support/Annotations.h
Removed:
################################################################################
diff --git a/llvm/include/llvm/Testing/Support/Annotations.h b/llvm/include/llvm/Testing/Support/Annotations.h
index 1cac1f13618f7..fc9e195a4ad4b 100644
--- a/llvm/include/llvm/Testing/Support/Annotations.h
+++ b/llvm/include/llvm/Testing/Support/Annotations.h
@@ -73,8 +73,8 @@ class Annotations {
/// Order matches the order within the text.
std::vector<size_t> points(llvm::StringRef Name = "") const;
/// Returns the mapping of all names of points marked in the text to their
- /// position. Unnamed points are mapped to the empty string. Order of points
- /// for each name matches the order within the text.
+ /// position. Unnamed points are mapped to the empty string. The positions are
+ /// sorted.
const llvm::StringMap<llvm::SmallVector<size_t, 1>> &all_points() const;
/// Returns the location of the range marked by [[ ]] (or $name[[ ]]).
@@ -84,8 +84,8 @@ class Annotations {
/// They are ordered by start position within the text.
std::vector<Range> ranges(llvm::StringRef Name = "") const;
/// Returns the mapping of all names of ranges marked in the text to their
- /// location. Unnamed ranges are mapped to the empty string. Order of ranges
- /// for each name matches the order of start positions within the text.
+ /// location. Unnamed ranges are mapped to the empty string. The ranges are
+ /// sorted by their start position.
const llvm::StringMap<llvm::SmallVector<Range, 1>> &all_ranges() const;
private:
More information about the llvm-commits
mailing list