[clang-tidy] Update docs for clang-tidy checks. NFC

Changes mostly address formatting and unification of the style. Use
MarkDown style for inline code snippets and lists. Added some text
for a few checks.

The idea is to move most of the documentation out to separate rST files and have
implementation files refer to the corresponding documentation files.

llvm-svn: 246169

1 files changed, 8 insertions, 8 deletions

diff --git a/clang-tools-extra/clang-tidy/misc/AssertSideEffectCheck.h b/clang-tools-extra/clang-tidy/misc/AssertSideEffectCheck.h
index 4d0be43a63e..1ca278dcacb 100644
--- a/clang-tools-extra/clang-tidy/misc/AssertSideEffectCheck.h
+++ b/clang-tools-extra/clang-tidy/misc/AssertSideEffectCheck.h
@@ -18,19 +18,19 @@
 namespace clang {
 namespace tidy {
 
-/// \brief Finds \c assert() with side effect.
+/// Finds `assert()` with side effect.
 ///
-/// The condition of \c assert() is evaluated only in debug builds so a
+/// The condition of `assert()` is evaluated only in debug builds so a
 /// condition with side effect can cause different behavior in debug / release
 /// builds.
 ///
 /// There are two options:
-/// - AssertMacros: A comma-separated list of the names of assert macros to be
-///   checked.
-/// - CheckFunctionCalls: Whether to treat non-const member and non-member
-///   functions as they produce side effects. Disabled by default because it can
-///   increase the number of false positive warnings.
-
+///
+///   - `AssertMacros`: A comma-separated list of the names of assert macros to
+///     be checked.
+///   - `CheckFunctionCalls`: Whether to treat non-const member and non-member
+///     functions as they produce side effects. Disabled by default because it
+///     can increase the number of false positive warnings.
 class AssertSideEffectCheck : public ClangTidyCheck {
 public:
   AssertSideEffectCheck(StringRef Name, ClangTidyContext *Context);