diff --git a/include/llvm/MC/MCContext.h b/include/llvm/MC/MCContext.h index 630db53ec02..c1db354d6d4 100644 --- a/include/llvm/MC/MCContext.h +++ b/include/llvm/MC/MCContext.h @@ -42,8 +42,8 @@ namespace llvm { class MCSectionELF; class MCSectionCOFF; - /// MCContext - Context object for machine code objects. This class owns all - /// of the sections that it creates. + /// Context object for machine code objects. This class owns all of the + /// sections that it creates. /// class MCContext { MCContext(const MCContext&) = delete; @@ -63,13 +63,13 @@ namespace llvm { /// The MCObjectFileInfo for this target. const MCObjectFileInfo *MOFI; - /// Allocator - Allocator object used for creating machine code objects. + /// Allocator object used for creating machine code objects. /// /// We use a bump pointer allocator to avoid the need to track all allocated /// objects. BumpPtrAllocator Allocator; - /// Symbols - Bindings of names to symbols. + /// Bindings of names to symbols. SymbolTable Symbols; /// ELF sections can have a corresponding symbol. This maps one to the @@ -84,12 +84,11 @@ namespace llvm { /// We have three labels represented by the pairs (1, 0), (2, 0) and (1, 1) DenseMap, MCSymbol*> LocalSymbols; - /// UsedNames - Keeps tracks of names that were used both for used declared - /// and artificial symbols. + /// Keeps tracks of names that were used both for used declared and + /// artificial symbols. StringMap UsedNames; - /// NextUniqueID - The next ID to dole out to an unnamed assembler temporary - /// symbol. + /// The next ID to dole out to an unnamed assembler temporary symbol. unsigned NextUniqueID; /// Instances of directional local labels. @@ -206,18 +205,17 @@ namespace llvm { /// @name Symbol Management /// @{ - /// CreateLinkerPrivateTempSymbol - Create and return a new linker temporary - /// symbol with a unique but unspecified name. + /// Create and return a new linker temporary symbol with a unique but + /// unspecified name. MCSymbol *CreateLinkerPrivateTempSymbol(); - /// CreateTempSymbol - Create and return a new assembler temporary symbol - /// with a unique but unspecified name. + /// Create and return a new assembler temporary symbol with a unique but + /// unspecified name. MCSymbol *CreateTempSymbol(); MCSymbol *createTempSymbol(const Twine &Name); - /// getUniqueSymbolID() - Return a unique identifier for use in constructing - /// symbol names. + /// Return a unique identifier for use in constructing symbol names. unsigned getUniqueSymbolID() { return NextUniqueID++; } /// Create the definition of a directional local symbol for numbered label @@ -228,9 +226,8 @@ namespace llvm { /// for "1b" or 1f" references). MCSymbol *GetDirectionalLocalSymbol(unsigned LocalLabelVal, bool Before); - /// GetOrCreateSymbol - Lookup the symbol inside with the specified - /// @p Name. If it exists, return it. If not, create a forward - /// reference and return it. + /// Lookup the symbol inside with the specified @p Name. If it exists, + /// return it. If not, create a forward reference and return it. /// /// @param Name - The symbol name, which must be unique across all symbols. MCSymbol *GetOrCreateSymbol(StringRef Name); @@ -240,7 +237,7 @@ namespace llvm { MCSymbol *getOrCreateFrameAllocSymbol(StringRef FuncName, unsigned Idx); - /// LookupSymbol - Get the symbol for \p Name, or null. + /// Get the symbol for \p Name, or null. MCSymbol *LookupSymbol(StringRef Name) const; MCSymbol *LookupSymbol(const Twine &Name) const; @@ -257,8 +254,8 @@ namespace llvm { /// @name Section Management /// @{ - /// getMachOSection - Return the MCSection for the specified mach-o section. - /// This requires the operands to be valid. + /// Return the MCSection for the specified mach-o section. This requires + /// the operands to be valid. const MCSectionMachO *getMachOSection(StringRef Segment, StringRef Section, unsigned TypeAndAttributes, @@ -328,7 +325,7 @@ namespace llvm { /// \brief Set the main file name and override the default. void setMainFileName(StringRef S) { MainFileName = S; } - /// GetDwarfFile - creates an entry in the dwarf file and directory tables. + /// Creates an entry in the dwarf file and directory tables. unsigned GetDwarfFile(StringRef Directory, StringRef FileName, unsigned FileNumber, unsigned CUID); @@ -371,10 +368,10 @@ namespace llvm { getMCDwarfLineTable(CUID).setCompilationDir(CompilationDir); } - /// setCurrentDwarfLoc - saves the information from the currently parsed - /// dwarf .loc directive and sets DwarfLocSeen. When the next instruction - /// is assembled an entry in the line number table with this information and - /// the address of the instruction will be created. + /// Saves the information from the currently parsed dwarf .loc directive + /// and sets DwarfLocSeen. When the next instruction is assembled an entry + /// in the line number table with this information and the address of the + /// instruction will be created. void setCurrentDwarfLoc(unsigned FileNum, unsigned Line, unsigned Column, unsigned Flags, unsigned Isa, unsigned Discriminator) {