Style update: don't duplicate comments, they were getting out of sync.

llvm-svn: 207909

include/llvm-c/lto.h

@@ -403,8 +403,9 @@ lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
                                int nargs);
 
 /**
- * Tells LTO optimization passes that this symbol must be preserved
+ * Adds to a list of all global symbols that must exist in the final generated
- * because it is referenced by native code or a command line option.
+ * code. If a function is not listed there, it might be inlined into every usage
+ * and optimized away.
  *
  * \since prior to LTO_API_VERSION=3
  */

tools/lto/lto.cpp

@@ -70,37 +70,27 @@ static void lto_add_attrs(lto_code_gen_t cg) {
   }
 }
 
-/// lto_get_version - Returns a printable string.
 extern const char* lto_get_version() {
   return LTOCodeGenerator::getVersionString();
 }
 
-/// lto_get_error_message - Returns the last error string or NULL if last
-/// operation was successful.
 const char* lto_get_error_message() {
   return sLastErrorString.c_str();
 }
 
-/// lto_module_is_object_file - Validates if a file is a loadable object file.
 bool lto_module_is_object_file(const char* path) {
   return LTOModule::isBitcodeFile(path);
 }
 
-/// lto_module_is_object_file_for_target - Validates if a file is a loadable
-/// object file compilable for requested target.
 bool lto_module_is_object_file_for_target(const char* path,
                                           const char* target_triplet_prefix) {
   return LTOModule::isBitcodeFileForTarget(path, target_triplet_prefix);
 }
 
-/// lto_module_is_object_file_in_memory - Validates if a buffer is a loadable
-/// object file.
 bool lto_module_is_object_file_in_memory(const void* mem, size_t length) {
   return LTOModule::isBitcodeFile(mem, length);
 }
 
-/// lto_module_is_object_file_in_memory_for_target - Validates if a buffer is a
-/// loadable object file compilable for the target.
 bool
 lto_module_is_object_file_in_memory_for_target(const void* mem,
                                             size_t length,
@@ -108,24 +98,18 @@ lto_module_is_object_file_in_memory_for_target(const void* mem,
   return LTOModule::isBitcodeFileForTarget(mem, length, target_triplet_prefix);
 }
 
-/// lto_module_create - Loads an object file from disk. Returns NULL on error
-/// (check lto_get_error_message() for details).
 lto_module_t lto_module_create(const char* path) {
   lto_initialize();
   llvm::TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
   return LTOModule::makeLTOModule(path, Options, sLastErrorString);
 }
 
-/// lto_module_create_from_fd - Loads an object file from disk. Returns NULL on
-/// error (check lto_get_error_message() for details).
 lto_module_t lto_module_create_from_fd(int fd, const char *path, size_t size) {
   lto_initialize();
   llvm::TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
   return LTOModule::makeLTOModule(fd, path, size, Options, sLastErrorString);
 }
 
-/// lto_module_create_from_fd_at_offset - Loads an object file from disk.
-/// Returns NULL on error (check lto_get_error_message() for details).
 lto_module_t lto_module_create_from_fd_at_offset(int fd, const char *path,
                                                  size_t file_size,
                                                  size_t map_size,
@@ -136,16 +120,12 @@ lto_module_t lto_module_create_from_fd_at_offset(int fd, const char *path,
                                   sLastErrorString);
 }
 
-/// lto_module_create_from_memory - Loads an object file from memory. Returns
-/// NULL on error (check lto_get_error_message() for details).
 lto_module_t lto_module_create_from_memory(const void* mem, size_t length) {
   lto_initialize();
   llvm::TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
   return LTOModule::makeLTOModule(mem, length, Options, sLastErrorString);
 }
 
-/// Loads an object file from memory with an extra path argument.
-/// Returns NULL on error (check lto_get_error_message() for details).
 lto_module_t lto_module_create_from_memory_with_path(const void* mem,
                                                      size_t length,
                                                      const char *path) {
@@ -154,74 +134,53 @@ lto_module_t lto_module_create_from_memory_with_path(const void* mem,
   return LTOModule::makeLTOModule(mem, length, Options, sLastErrorString, path);
 }
 
-/// lto_module_dispose - Frees all memory for a module. Upon return the
-/// lto_module_t is no longer valid.
 void lto_module_dispose(lto_module_t mod) {
   delete mod;
 }
 
-/// lto_module_get_target_triple - Returns triplet string which the object
-/// module was compiled under.
 const char* lto_module_get_target_triple(lto_module_t mod) {
   return mod->getTargetTriple();
 }
 
-/// lto_module_set_target_triple - Sets triple string with which the object will
-/// be codegened.
 void lto_module_set_target_triple(lto_module_t mod, const char *triple) {
   return mod->setTargetTriple(triple);
 }
 
-/// lto_module_get_num_symbols - Returns the number of symbols in the object
-/// module.
 unsigned int lto_module_get_num_symbols(lto_module_t mod) {
   return mod->getSymbolCount();
 }
 
-/// lto_module_get_symbol_name - Returns the name of the ith symbol in the
-/// object module.
 const char* lto_module_get_symbol_name(lto_module_t mod, unsigned int index) {
   return mod->getSymbolName(index);
 }
 
-/// lto_module_get_symbol_attribute - Returns the attributes of the ith symbol
-/// in the object module.
 lto_symbol_attributes lto_module_get_symbol_attribute(lto_module_t mod,
                                                       unsigned int index) {
   return mod->getSymbolAttributes(index);
 }
 
-/// lto_module_get_num_deplibs - Returns the number of dependent libraries in
-/// the object module.
 unsigned int lto_module_get_num_deplibs(lto_module_t mod) {
   return mod->getDependentLibraryCount();
 }
 
-/// lto_module_get_deplib - Returns the ith dependent library in the module.
 const char* lto_module_get_deplib(lto_module_t mod, unsigned int index) {
   return mod->getDependentLibrary(index);
 }
 
-/// lto_module_get_num_linkeropts - Returns the number of linker options in the
-/// object module.
 unsigned int lto_module_get_num_linkeropts(lto_module_t mod) {
   return mod->getLinkerOptCount();
 }
 
-/// lto_module_get_linkeropt - Returns the ith linker option in the module.
 const char* lto_module_get_linkeropt(lto_module_t mod, unsigned int index) {
   return mod->getLinkerOpt(index);
 }
 
-/// Set a diagnostic handler.
 void lto_codegen_set_diagnostic_handler(lto_code_gen_t cg,
                                         lto_diagnostic_handler_t diag_handler,
                                         void *ctxt) {
   cg->setDiagnosticHandler(diag_handler, ctxt);
 }
 
-/// lto_codegen_create - Instantiates a code generator. Returns NULL if there
-/// is an error.
 lto_code_gen_t lto_codegen_create(void) {
   lto_initialize();
 
@@ -233,67 +192,46 @@ lto_code_gen_t lto_codegen_create(void) {
   return CodeGen;
 }
 
-/// lto_codegen_dispose - Frees all memory for a code generator. Upon return the
-/// lto_code_gen_t is no longer valid.
 void lto_codegen_dispose(lto_code_gen_t cg) {
   delete cg;
 }
 
-/// lto_codegen_add_module - Add an object module to the set of modules for
-/// which code will be generated. Returns true on error (check
-/// lto_get_error_message() for details).
 bool lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod) {
   return !cg->addModule(mod, sLastErrorString);
 }
 
-/// lto_codegen_set_debug_model - Sets what if any format of debug info should
-/// be generated. Returns true on error (check lto_get_error_message() for
-/// details).
 bool lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model debug) {
   cg->setDebugInfo(debug);
   return false;
 }
 
-/// lto_codegen_set_pic_model - Sets what code model to generated. Returns true
-/// on error (check lto_get_error_message() for details).
 bool lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model model) {
   cg->setCodePICModel(model);
   return false;
 }
 
-/// lto_codegen_set_cpu - Sets the cpu to generate code for.
 void lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu) {
   return cg->setCpu(cpu);
 }
 
-/// lto_codegen_set_attr - Sets the attr to generate code for.
 void lto_codegen_set_attr(lto_code_gen_t cg, const char *attr) {
   return cg->setAttr(attr);
 }
 
-/// lto_codegen_set_assembler_path - Sets the path to the assembler tool.
 void lto_codegen_set_assembler_path(lto_code_gen_t cg, const char *path) {
   // In here only for backwards compatibility. We use MC now.
 }
 
-/// lto_codegen_set_assembler_args - Sets extra arguments that libLTO should
-/// pass to the assembler.
 void lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
                                     int nargs) {
   // In here only for backwards compatibility. We use MC now.
 }
 
-/// lto_codegen_add_must_preserve_symbol - Adds to a list of all global symbols
-/// that must exist in the final generated code. If a function is not listed
-/// there, it might be inlined into every usage and optimized away.
 void lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg,
                                           const char *symbol) {
   cg->addMustPreserveSymbol(symbol);
 }
 
-/// lto_codegen_write_merged_modules - Writes a new file at the specified path
-/// that contains the merged contents of all modules added so far. Returns true
-/// on error (check lto_get_error_message() for details).
 bool lto_codegen_write_merged_modules(lto_code_gen_t cg, const char *path) {
   if (!parsedOptions) {
     cg->parseCodeGenDebugOptions();
@@ -303,12 +241,6 @@ bool lto_codegen_write_merged_modules(lto_code_gen_t cg, const char *path) {
   return !cg->writeMergedModules(path, sLastErrorString);
 }
 
-/// lto_codegen_compile - Generates code for all added modules into one native
-/// object file. On success returns a pointer to a generated mach-o/ELF buffer
-/// and length set to the buffer size. The buffer is owned by the lto_code_gen_t
-/// object and will be freed when lto_codegen_dispose() is called, or
-/// lto_codegen_compile() is called again. On failure, returns NULL (check
-/// lto_get_error_message() for details).
 const void *lto_codegen_compile(lto_code_gen_t cg, size_t *length) {
   if (!parsedOptions) {
     cg->parseCodeGenDebugOptions();
@@ -319,9 +251,6 @@ const void *lto_codegen_compile(lto_code_gen_t cg, size_t *length) {
                      sLastErrorString);
 }
 
-/// lto_codegen_compile_to_file - Generates code for all added modules into one
-/// native object file. The name of the file is written to name. Returns true on
-/// error.
 bool lto_codegen_compile_to_file(lto_code_gen_t cg, const char **name) {
   if (!parsedOptions) {
     cg->parseCodeGenDebugOptions();
@@ -332,8 +261,6 @@ bool lto_codegen_compile_to_file(lto_code_gen_t cg, const char **name) {
                               sLastErrorString);
 }
 
-/// lto_codegen_debug_options - Used to pass extra options to the code
-/// generator.
 void lto_codegen_debug_options(lto_code_gen_t cg, const char *opt) {
   cg->setCodeGenDebugOptions(opt);
 }