From 7bb47a046fe023c09cca2500e39eba5f440fbb99 Mon Sep 17 00:00:00 2001 From: Jakub Kuderski Date: Thu, 30 Sep 2021 10:28:10 -0400 Subject: [PATCH] [NFC] Improve file-level documentation for Sequence.h Add usage samples. This was extracted from a bigger patch: https://reviews.llvm.org/D107378. Reviewed By: aaron.ballman, gchatelet Differential Revision: https://reviews.llvm.org/D110760 --- llvm/include/llvm/ADT/Sequence.h | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/llvm/include/llvm/ADT/Sequence.h b/llvm/include/llvm/ADT/Sequence.h index 3e4bf09..9fcb303 100644 --- a/llvm/include/llvm/ADT/Sequence.h +++ b/llvm/include/llvm/ADT/Sequence.h @@ -6,9 +6,30 @@ // //===----------------------------------------------------------------------===// /// \file -/// This routine provides some synthesis utilities to produce sequences of -/// values. The names are intentionally kept very short as they tend to occur -/// in common and widely used contexts. +/// Provides some synthesis utilities to produce sequences of values. The names +/// are intentionally kept very short as they tend to occur in common and +/// widely used contexts. +/// +/// The `seq(A, B)` function produces a sequence of values from `A` to up to +/// (but not including) `B`, i.e., [`A`, `B`), that can be safely iterated over. +/// `seq` supports both integral (e.g., `int`, `char`, `uint32_t`) and enum +/// types. `seq_inclusive(A, B)` produces a sequence of values from `A` to `B`, +/// including `B`. +/// +/// Examples with integral types: +/// ``` +/// for (int x : seq(0, 3)) +/// outs() << x << " "; +/// ``` +/// +/// Prints: `0 1 2 `. +/// +/// ``` +/// for (int x : seq_inclusive(0, 3)) +/// outs() << x << " "; +/// ``` +/// +/// Prints: `0 1 2 3 `. /// //===----------------------------------------------------------------------===// -- 2.7.4