From 8811865e492427392cc800ac9536d05150eeb6df Mon Sep 17 00:00:00 2001 From: James Dennett Date: Wed, 20 Jun 2012 21:55:51 +0000 Subject: [PATCH] Documentation cleanup: * Escape < characters in Doxygen comments as needed; * Add \code...\endcode around code examples; * Remove an incorrect use of Doxygen's \arg command. llvm-svn: 158859 --- .../clang/Frontend/VerifyDiagnosticConsumer.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/clang/include/clang/Frontend/VerifyDiagnosticConsumer.h b/clang/include/clang/Frontend/VerifyDiagnosticConsumer.h index 2fc6ccc36d55..357246c1ce13 100644 --- a/clang/include/clang/Frontend/VerifyDiagnosticConsumer.h +++ b/clang/include/clang/Frontend/VerifyDiagnosticConsumer.h @@ -35,18 +35,22 @@ class TextDiagnosticBuffer; /// /// Here's an example: /// +/// \code /// int A = B; // expected-error {{use of undeclared identifier 'B'}} +/// \endcode /// /// You can place as many diagnostics on one line as you wish. To make the code /// more readable, you can use slash-newline to separate out the diagnostics. /// /// The simple syntax above allows each specification to match exactly one /// error. You can use the extended syntax to customize this. The extended -/// syntax is "expected- {{diag text}}", where is one of -/// "error", "warning" or "note", and is a positive integer. This allows the -/// diagnostic to appear as many times as specified. Example: +/// syntax is "expected- {{diag text}}", where \ is one of +/// "error", "warning" or "note", and \ is a positive integer. This allows +/// the diagnostic to appear as many times as specified. Example: /// +/// \code /// void f(); // expected-note 2 {{previous declaration is here}} +/// \endcode /// /// Regex matching mode may be selected by appending '-re' to type. Example: /// @@ -75,7 +79,7 @@ private: void CheckDiagnostics(); public: - /// Create a new verifying diagnostic client, which will issue errors to \arg + /// Create a new verifying diagnostic client, which will issue errors to /// the currently-attached diagnostic client when a diagnostic does not match /// what is expected (as indicated in the source file). VerifyDiagnosticConsumer(DiagnosticsEngine &Diags);