Update comments to match recommended doxygen style.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170320 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp b/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp
index d0a98d1..16b91d9 100644 (file)
--- a/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp
+++ b/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp
@@ -6,9 +6,10 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
-//
-// This file is part of the XCore Disassembler.
-//
+///
+/// \file
+/// \brief This file is part of the XCore Disassembler.
+///
 //===----------------------------------------------------------------------===//
 
 #include "XCore.h"
@@ -26,16 +27,14 @@ typedef MCDisassembler::DecodeStatus DecodeStatus;
 
 namespace {
 
-/// XCoreDisassembler - a disasembler class for XCore.
+/// \brief A disassembler class for XCore.
 class XCoreDisassembler : public MCDisassembler {
   const MCRegisterInfo *RegInfo;
 public:
-  /// Constructor     - Initializes the disassembler.
-  ///
   XCoreDisassembler(const MCSubtargetInfo &STI, const MCRegisterInfo *Info) :
     MCDisassembler(STI), RegInfo(Info) {}
 
-  /// getInstruction - See MCDisassembler.
+  /// \brief See MCDisassembler.
   virtual DecodeStatus getInstruction(MCInst &instr,
                                       uint64_t &size,
                                       const MemoryObject &region,

diff --git a/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h b/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h
index c394560..772c515 100644 (file)
--- a/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h
+++ b/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h
@@ -6,9 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
-//
-// This class prints a XCore MCInst to a .s file.
-//
+///
+/// \file
+/// \brief This file contains the declaration of the XCoreInstPrinter class,
+/// which is used to print XCore MCInst to a .s file.
+///
 //===----------------------------------------------------------------------===//
 
 #ifndef XCOREINSTPRINTER_H

diff --git a/lib/Target/XCore/XCoreMCInstLower.cpp b/lib/Target/XCore/XCoreMCInstLower.cpp
index 7cdbada..f96eda9 100644 (file)
--- a/lib/Target/XCore/XCoreMCInstLower.cpp
+++ b/lib/Target/XCore/XCoreMCInstLower.cpp
@@ -6,10 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
-//
-// This file contains code to lower XCore MachineInstrs to their corresponding
-// MCInst records.
-//
+///
+/// \file
+/// \brief This file contains code to lower XCore MachineInstrs to their
+/// corresponding MCInst records.
+///
 //===----------------------------------------------------------------------===//
 #include "XCoreMCInstLower.h"
 #include "llvm/CodeGen/AsmPrinter.h"

diff --git a/lib/Target/XCore/XCoreMCInstLower.h b/lib/Target/XCore/XCoreMCInstLower.h
index fb138f0..28e702b 100644 (file)
--- a/lib/Target/XCore/XCoreMCInstLower.h
+++ b/lib/Target/XCore/XCoreMCInstLower.h
@@ -21,8 +21,7 @@ namespace llvm {
   class Mangler;
   class AsmPrinter;
 
-/// XCoreMCInstLower - This class is used to lower an MachineInstr into an
-//                     MCInst.
+/// \brief This class is used to lower an MachineInstr into an MCInst.
 class LLVM_LIBRARY_VISIBILITY XCoreMCInstLower {
   typedef MachineOperand::MachineOperandType MachineOperandType;
   MCContext *Ctx;