diff options
| author | Chris Lattner <sabre@nondot.org> | 2009-07-01 06:08:37 +0000 |
|---|---|---|
| committer | Chris Lattner <sabre@nondot.org> | 2009-07-01 06:08:37 +0000 |
| commit | e18e0c58dcd740c64e962fefde44249d685d0568 (patch) | |
| tree | 08553e8d9d9ff18bee02af49eae8d3717afb302b | |
| parent | 0fd38069cb6699ce21eb159f22d3f23c012c9e81 (diff) | |
| download | external_llvm-e18e0c58dcd740c64e962fefde44249d685d0568.zip external_llvm-e18e0c58dcd740c64e962fefde44249d685d0568.tar.gz external_llvm-e18e0c58dcd740c64e962fefde44249d685d0568.tar.bz2 | |
improve comments.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74589 91177308-0d34-0410-b5e6-96231b3b80d8
| -rw-r--r-- | include/llvm/MC/MCStreamer.h | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/include/llvm/MC/MCStreamer.h b/include/llvm/MC/MCStreamer.h index 793af5d..54de8a3 100644 --- a/include/llvm/MC/MCStreamer.h +++ b/include/llvm/MC/MCStreamer.h @@ -6,6 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// +// +// This file declares the MCStreamer class. +// +//===----------------------------------------------------------------------===// #ifndef LLVM_MC_MCSTREAMER_H #define LLVM_MC_MCSTREAMER_H @@ -20,7 +24,15 @@ namespace llvm { class MCSymbol; class raw_ostream; - /// MCStreamer - Streaming machine code generation interface. + /// MCStreamer - Streaming machine code generation interface. This interface + /// is intended to provide a programatic interface that is very similar to the + /// level that an assembler .s file provides. It has callbacks to emit bytes, + /// "emit directives", etc. The implementation of this interface retains + /// state to know what the current section is etc. + /// + /// There are multiple implementations of this interface: one for writing out + /// a .s file, and implementations that write out .o files of various formats. + /// class MCStreamer { public: enum SymbolAttr { |