Style fix: don't duplicate the method names.

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

include/llvm/LTO/LTOCodeGenerator.h

@@ -56,8 +56,7 @@ namespace llvm {
 }
 
 //===----------------------------------------------------------------------===//
-/// LTOCodeGenerator - C++ class which implements the opaque lto_code_gen_t
+/// C++ class which implements the opaque lto_code_gen_t type.
-/// type.
 ///
 struct LTOCodeGenerator {
   static const char *getVersionString();

include/llvm/LTO/LTOModule.h

@@ -34,7 +34,7 @@ namespace llvm {
 }
 
 //===----------------------------------------------------------------------===//
-/// LTOModule - C++ class which implements the opaque lto_module_t type.
+/// C++ class which implements the opaque lto_module_t type.
 ///
 struct LTOModule {
 private:
@@ -66,22 +66,21 @@ private:
 
   LTOModule(llvm::Module *m, llvm::TargetMachine *t);
 public:
-  /// isBitcodeFile - Returns 'true' if the file or memory contents is LLVM
+  /// Returns 'true' if the file or memory contents is LLVM bitcode.
-  /// bitcode.
   static bool isBitcodeFile(const void *mem, size_t length);
   static bool isBitcodeFile(const char *path);
 
-  /// isBitcodeFileForTarget - Returns 'true' if the file or memory contents
+  /// Returns 'true' if the file or memory contents is LLVM bitcode for the
-  /// is LLVM bitcode for the specified triple.
+  /// specified triple.
   static bool isBitcodeFileForTarget(const void *mem,
                                      size_t length,
                                      const char *triplePrefix);
   static bool isBitcodeFileForTarget(const char *path,
                                      const char *triplePrefix);
 
-  /// makeLTOModule - Create an LTOModule. N.B. These methods take ownership
+  /// Create an LTOModule. N.B. These methods take ownership of the buffer. The
-  /// of the buffer. The caller must have initialized the Targets, the
+  /// caller must have initialized the Targets, the TargetMCs, the AsmPrinters,
-  /// TargetMCs, the AsmPrinters, and the AsmParsers by calling:
+  /// and the AsmParsers by calling:
   ///
   /// InitializeAllTargets();
   /// InitializeAllTargetMCs();
@@ -102,122 +101,115 @@ public:
                                   std::string &errMsg,
                                   llvm::StringRef path = "");
 
-  /// getTargetTriple - Return the Module's target triple.
+  /// Return the Module's target triple.
   const char *getTargetTriple() {
     return _module->getTargetTriple().c_str();
   }
 
-  /// setTargetTriple - Set the Module's target triple.
+  /// Set the Module's target triple.
   void setTargetTriple(const char *triple) {
     _module->setTargetTriple(triple);
   }
 
-  /// getSymbolCount - Get the number of symbols
+  /// Get the number of symbols
   uint32_t getSymbolCount() {
     return _symbols.size();
   }
 
-  /// getSymbolAttributes - Get the attributes for a symbol at the specified
+  /// Get the attributes for a symbol at the specified index.
-  /// index.
   lto_symbol_attributes getSymbolAttributes(uint32_t index) {
     if (index < _symbols.size())
       return lto_symbol_attributes(_symbols[index].attributes);
     return lto_symbol_attributes(0);
   }
 
-  /// getSymbolName - Get the name of the symbol at the specified index.
+  /// Get the name of the symbol at the specified index.
   const char *getSymbolName(uint32_t index) {
     if (index < _symbols.size())
       return _symbols[index].name;
     return nullptr;
   }
 
-  /// getDependentLibraryCount - Get the number of dependent libraries
+  /// Get the number of dependent libraries
   uint32_t getDependentLibraryCount() {
     return _deplibs.size();
   }
 
-  /// getDependentLibrary - Get the dependent library at the specified index.
+  /// Get the dependent library at the specified index.
   const char *getDependentLibrary(uint32_t index) {
     if (index < _deplibs.size())
       return _deplibs[index];
     return nullptr;
   }
 
-  /// getLinkerOptCount - Get the number of linker options
+  /// Get the number of linker options
   uint32_t getLinkerOptCount() {
     return _linkeropts.size();
   }
 
-  /// getLinkerOpt - Get the linker option at the specified index.
+  /// Get the linker option at the specified index.
   const char *getLinkerOpt(uint32_t index) {
     if (index < _linkeropts.size())
       return _linkeropts[index];
     return nullptr;
   }
 
-  /// getLLVVMModule - Return the Module.
+  /// Return the Module.
   llvm::Module *getLLVVMModule() { return _module.get(); }
 
-  /// getAsmUndefinedRefs -
   const std::vector<const char*> &getAsmUndefinedRefs() {
     return _asm_undefines;
   }
 
 private:
-  /// parseMetadata - Parse metadata from the module
+  /// Parse metadata from the module
   // FIXME: it only parses "Linker Options" metadata at the moment
   void parseMetadata();
 
-  /// parseSymbols - Parse the symbols from the module and model-level ASM and
+  /// Parse the symbols from the module and model-level ASM and add them to
-  /// add them to either the defined or undefined lists.
+  /// either the defined or undefined lists.
   bool parseSymbols(std::string &errMsg);
 
-  /// addPotentialUndefinedSymbol - Add a symbol which isn't defined just yet
+  /// Add a symbol which isn't defined just yet to a list to be resolved later.
-  /// to a list to be resolved later.
   void addPotentialUndefinedSymbol(const llvm::GlobalValue *dcl, bool isFunc);
 
-  /// addDefinedSymbol - Add a defined symbol to the list.
+  /// Add a defined symbol to the list.
   void addDefinedSymbol(const llvm::GlobalValue *def, bool isFunction);
 
-  /// addDefinedFunctionSymbol - Add a function symbol as defined to the list.
+  /// Add a function symbol as defined to the list.
   void addDefinedFunctionSymbol(const llvm::Function *f);
 
-  /// addDefinedDataSymbol - Add a data symbol as defined to the list.
+  /// Add a data symbol as defined to the list.
   void addDefinedDataSymbol(const llvm::GlobalValue *v);
 
-  /// addAsmGlobalSymbols - Add global symbols from module-level ASM to the
+  /// Add global symbols from module-level ASM to the defined or undefined
-  /// defined or undefined lists.
+  /// lists.
   bool addAsmGlobalSymbols(std::string &errMsg);
 
-  /// addAsmGlobalSymbol - Add a global symbol from module-level ASM to the
+  /// Add a global symbol from module-level ASM to the defined list.
-  /// defined list.
   void addAsmGlobalSymbol(const char *, lto_symbol_attributes scope);
 
-  /// addAsmGlobalSymbolUndef - Add a global symbol from module-level ASM to
+  /// Add a global symbol from module-level ASM to the undefined list.
-  /// the undefined list.
   void addAsmGlobalSymbolUndef(const char *);
 
-  /// addObjCClass - Parse i386/ppc ObjC class data structure.
+  /// Parse i386/ppc ObjC class data structure.
   void addObjCClass(const llvm::GlobalVariable *clgv);
 
-  /// addObjCCategory - Parse i386/ppc ObjC category data structure.
+  /// Parse i386/ppc ObjC category data structure.
   void addObjCCategory(const llvm::GlobalVariable *clgv);
 
-  /// addObjCClassRef - Parse i386/ppc ObjC class list data structure.
+  /// Parse i386/ppc ObjC class list data structure.
   void addObjCClassRef(const llvm::GlobalVariable *clgv);
 
-  /// objcClassNameFromExpression - Get string that the data pointer points
+  /// Get string that the data pointer points to.
-  /// to.
   bool objcClassNameFromExpression(const llvm::Constant* c, std::string &name);
 
-  /// isTargetMatch - Returns 'true' if the memory buffer is for the specified
+  /// Returns 'true' if the memory buffer is for the specified target triple.
-  /// target triple.
   static bool isTargetMatch(llvm::MemoryBuffer *memBuffer,
                             const char *triplePrefix);
 
-  /// makeLTOModule - Create an LTOModule (private version). N.B. This
+  /// Create an LTOModule (private version). N.B. This method takes ownership of
-  /// method takes ownership of the buffer.
+  /// the buffer.
   static LTOModule *makeLTOModule(llvm::MemoryBuffer *buffer,
                                   llvm::TargetOptions options,
                                   std::string &errMsg);