diff options
author | Richard Osborne <richard@xmos.com> | 2012-12-17 12:13:41 +0000 |
---|---|---|
committer | Richard Osborne <richard@xmos.com> | 2012-12-17 12:13:41 +0000 |
commit | b4d40a04f0639fdec8329a8708565411fa53b5bc (patch) | |
tree | 5a840b700932a83e37070a218e7fb22af3b07279 | |
parent | 31061e68a27e5ac9786f23dbc29a22383039e525 (diff) | |
download | external_llvm-b4d40a04f0639fdec8329a8708565411fa53b5bc.zip external_llvm-b4d40a04f0639fdec8329a8708565411fa53b5bc.tar.gz external_llvm-b4d40a04f0639fdec8329a8708565411fa53b5bc.tar.bz2 |
Update comments to match recommended doxygen style.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170320 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r-- | lib/Target/XCore/Disassembler/XCoreDisassembler.cpp | 13 | ||||
-rw-r--r-- | lib/Target/XCore/InstPrinter/XCoreInstPrinter.h | 8 | ||||
-rw-r--r-- | lib/Target/XCore/XCoreMCInstLower.cpp | 9 | ||||
-rw-r--r-- | lib/Target/XCore/XCoreMCInstLower.h | 3 |
4 files changed, 17 insertions, 16 deletions
diff --git a/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp b/lib/Target/XCore/Disassembler/XCoreDisassembler.cpp index d0a98d13..16b91d9 100644 --- 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 ®ion, diff --git a/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h b/lib/Target/XCore/InstPrinter/XCoreInstPrinter.h index c394560..772c515 100644 --- 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 --- 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 --- 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; |