Regex: +regex string lifetime comment

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

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

diff --git a/include/llvm/Support/Regex.h b/include/llvm/Support/Regex.h
index 2d19b10fd890762283038e8e0f868e4d4d1f6839..b05349dee8888f92e5f1730895d347f302df4006 100644 (file)
--- a/include/llvm/Support/Regex.h
+++ b/include/llvm/Support/Regex.h
@@ -44,6 +44,9 @@ namespace llvm {
 
     Regex();
     /// Compiles the given regular expression \p Regex.
+    ///
+    /// \param Regex - referenced string is no longer needed after this
+    /// constructor does finish.  Only its compiled form is kept stored.
     Regex(StringRef Regex, unsigned Flags = NoFlags);
     Regex(const Regex &) = delete;
     Regex &operator=(Regex regex) {