[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, 5 insertions, 5 deletions

diff --git a/clang-tools-extra/clang-tidy/misc/AssignOperatorSignatureCheck.h b/clang-tools-extra/clang-tidy/misc/AssignOperatorSignatureCheck.h
index 68c6fe33209..a2530f9314c 100644
--- a/clang-tools-extra/clang-tidy/misc/AssignOperatorSignatureCheck.h
+++ b/clang-tools-extra/clang-tidy/misc/AssignOperatorSignatureCheck.h
@@ -16,12 +16,12 @@ namespace clang {
 namespace tidy {
 namespace misc {
 
-/// \brief Finds declarations of assign operators with the wrong return and/or
-///   argument types.
+/// Finds declarations of assign operators with the wrong return and/or argument
+/// types.
 ///
-/// The return type must be \c Class&.
-/// Works with move-assign and assign by value.
-/// Private and deleted operators are ignored.
+///   * The return type must be `Class&`.
+///   * Works with move-assign and assign by value.
+///   * Private and deleted operators are ignored.
 class AssignOperatorSignatureCheck : public ClangTidyCheck {
 public:
   AssignOperatorSignatureCheck(StringRef Name, ClangTidyContext *Context)