[llvm-commits] [llvm] r170320 - in /llvm/trunk/lib/Target/XCore: Disassembler/XCoreDisassembler.cpp InstPrinter/XCoreInstPrinter.h XCoreMCInstLower.cpp XCoreMCInstLower.h

[Richard Osborne]

Author: friedgold
Date: Mon Dec 17 06:13:41 2012
New Revision: 170320

URL: http://llvm.org/viewvc/llvm-project?rev=170320&view=rev
Log:
Update comments to match recommended doxygen style.

Modified:
    llvm/trunk/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp
    llvm/trunk/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h
    llvm/trunk/lib/Target/XCore/XCoreMCInstLower.cpp
    llvm/trunk/lib/Target/XCore/XCoreMCInstLower.h

Modified: llvm/trunk/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp?rev=170320&r1=170319&r2=170320&view=diff
==============================================================================
--- llvm/trunk/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp (original)
+++ llvm/trunk/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp Mon Dec 17 06:13:41 2012
@@ -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 @@
 
 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,

Modified: llvm/trunk/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h?rev=170320&r1=170319&r2=170320&view=diff
==============================================================================
--- llvm/trunk/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h (original)
+++ llvm/trunk/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h Mon Dec 17 06:13:41 2012
@@ -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

Modified: llvm/trunk/lib/Target/XCore/XCoreMCInstLower.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/XCore/XCoreMCInstLower.cpp?rev=170320&r1=170319&r2=170320&view=diff
==============================================================================
--- llvm/trunk/lib/Target/XCore/XCoreMCInstLower.cpp (original)
+++ llvm/trunk/lib/Target/XCore/XCoreMCInstLower.cpp Mon Dec 17 06:13:41 2012
@@ -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"

Modified: llvm/trunk/lib/Target/XCore/XCoreMCInstLower.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/XCore/XCoreMCInstLower.h?rev=170320&r1=170319&r2=170320&view=diff
==============================================================================
--- llvm/trunk/lib/Target/XCore/XCoreMCInstLower.h (original)
+++ llvm/trunk/lib/Target/XCore/XCoreMCInstLower.h Mon Dec 17 06:13:41 2012
@@ -21,8 +21,7 @@
   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;