diff options
author | Dmitri Gribenko <gribozavr@gmail.com> | 2012-09-14 14:57:36 +0000 |
---|---|---|
committer | Dmitri Gribenko <gribozavr@gmail.com> | 2012-09-14 14:57:36 +0000 |
commit | c5252da873d547a19069eaf9030fec203f128f66 (patch) | |
tree | 0c83882516664cffb398aacead9a63a9c0c9b1dc /include/llvm/Support/Regex.h | |
parent | d0807690de6c735af84e35dd76a30420eaded16b (diff) | |
download | external_llvm-c5252da873d547a19069eaf9030fec203f128f66.tar.gz external_llvm-c5252da873d547a19069eaf9030fec203f128f66.tar.bz2 external_llvm-c5252da873d547a19069eaf9030fec203f128f66.zip |
Fix Doxygen issues:
* wrap code blocks in \code ... \endcode;
* refer to parameter names in paragraphs correctly (\arg is not what most
people want -- it starts a new paragraph);
* use \param instead of \arg to document parameters in order to be consistent
with the rest of the codebase.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@163902 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/Support/Regex.h')
-rw-r--r-- | include/llvm/Support/Regex.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/llvm/Support/Regex.h b/include/llvm/Support/Regex.h index 7648e77bfb..ffe09b19b6 100644 --- a/include/llvm/Support/Regex.h +++ b/include/llvm/Support/Regex.h @@ -36,7 +36,7 @@ namespace llvm { Newline=2 }; - /// Compiles the given POSIX Extended Regular Expression \arg Regex. + /// Compiles the given POSIX Extended Regular Expression \p Regex. /// This implementation supports regexes and matching strings with embedded /// NUL characters. Regex(StringRef Regex, unsigned Flags = NoFlags); @@ -51,17 +51,17 @@ namespace llvm { /// many entries plus one for the whole regex (as element 0). unsigned getNumMatches() const; - /// matches - Match the regex against a given \arg String. + /// matches - Match the regex against a given \p String. /// /// \param Matches - If given, on a successful match this will be filled in - /// with references to the matched group expressions (inside \arg String), + /// with references to the matched group expressions (inside \p String), /// the first group is always the entire pattern. /// /// This returns true on a successful match. bool match(StringRef String, SmallVectorImpl<StringRef> *Matches = 0); /// sub - Return the result of replacing the first match of the regex in - /// \arg String with the \arg Repl string. Backreferences like "\0" in the + /// \p String with the \p Repl string. Backreferences like "\0" in the /// replacement string are replaced with the appropriate match substring. /// /// Note that the replacement string has backslash escaping performed on |