mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2025-07-25 13:24:46 +00:00
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
This commit is contained in:
@@ -170,31 +170,47 @@ public:
|
||||
}
|
||||
};
|
||||
|
||||
/// format - This is a helper function that is used to produce formatted output.
|
||||
/// This is typically used like: OS << format("%0.4f", myfloat) << '\n';
|
||||
/// This is a helper function that is used to produce formatted output.
|
||||
///
|
||||
/// This is typically used like:
|
||||
/// \code
|
||||
/// OS << format("%0.4f", myfloat) << '\n';
|
||||
/// \endcode
|
||||
template <typename T>
|
||||
inline format_object1<T> format(const char *Fmt, const T &Val) {
|
||||
return format_object1<T>(Fmt, Val);
|
||||
}
|
||||
|
||||
/// format - This is a helper function that is used to produce formatted output.
|
||||
/// This is typically used like: OS << format("%0.4f", myfloat) << '\n';
|
||||
/// This is a helper function that is used to produce formatted output.
|
||||
///
|
||||
/// This is typically used like:
|
||||
/// \code
|
||||
/// OS << format("%0.4f", myfloat) << '\n';
|
||||
/// \endcode
|
||||
template <typename T1, typename T2>
|
||||
inline format_object2<T1, T2> format(const char *Fmt, const T1 &Val1,
|
||||
const T2 &Val2) {
|
||||
return format_object2<T1, T2>(Fmt, Val1, Val2);
|
||||
}
|
||||
|
||||
/// format - This is a helper function that is used to produce formatted output.
|
||||
/// This is typically used like: OS << format("%0.4f", myfloat) << '\n';
|
||||
/// This is a helper function that is used to produce formatted output.
|
||||
///
|
||||
/// This is typically used like:
|
||||
/// \code
|
||||
/// OS << format("%0.4f", myfloat) << '\n';
|
||||
/// \endcode
|
||||
template <typename T1, typename T2, typename T3>
|
||||
inline format_object3<T1, T2, T3> format(const char *Fmt, const T1 &Val1,
|
||||
const T2 &Val2, const T3 &Val3) {
|
||||
return format_object3<T1, T2, T3>(Fmt, Val1, Val2, Val3);
|
||||
}
|
||||
|
||||
/// format - This is a helper function that is used to produce formatted output.
|
||||
/// This is typically used like: OS << format("%0.4f", myfloat) << '\n';
|
||||
/// This is a helper function that is used to produce formatted output.
|
||||
///
|
||||
/// This is typically used like:
|
||||
/// \code
|
||||
/// OS << format("%0.4f", myfloat) << '\n';
|
||||
/// \endcode
|
||||
template <typename T1, typename T2, typename T3, typename T4>
|
||||
inline format_object4<T1, T2, T3, T4> format(const char *Fmt, const T1 &Val1,
|
||||
const T2 &Val2, const T3 &Val3,
|
||||
@@ -202,8 +218,12 @@ inline format_object4<T1, T2, T3, T4> format(const char *Fmt, const T1 &Val1,
|
||||
return format_object4<T1, T2, T3, T4>(Fmt, Val1, Val2, Val3, Val4);
|
||||
}
|
||||
|
||||
/// format - This is a helper function that is used to produce formatted output.
|
||||
/// This is typically used like: OS << format("%0.4f", myfloat) << '\n';
|
||||
/// This is a helper function that is used to produce formatted output.
|
||||
///
|
||||
/// This is typically used like:
|
||||
/// \code
|
||||
/// OS << format("%0.4f", myfloat) << '\n';
|
||||
/// \endcode
|
||||
template <typename T1, typename T2, typename T3, typename T4, typename T5>
|
||||
inline format_object5<T1, T2, T3, T4, T5> format(const char *Fmt,const T1 &Val1,
|
||||
const T2 &Val2, const T3 &Val3,
|
||||
|
@@ -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
|
||||
|
Reference in New Issue
Block a user