Added doxygen comments for the streaming module provider.
authorMisha Brukman <brukman+llvm@gmail.com>
Mon, 22 Sep 2003 23:40:38 +0000 (23:40 +0000)
committerMisha Brukman <brukman+llvm@gmail.com>
Mon, 22 Sep 2003 23:40:38 +0000 (23:40 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8672 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/Bytecode/Reader.h

index 62b512b25fb6ffe0437481bfc9fd419605cd7368..baf0603d3bf37d2cf29a1cb13562a7c0c1106d86 100644 (file)
 #include <string>
 #include <vector>
 
-///
+/// getBytecodeModuleProvider - lazy function-at-a-time loading from a file
 ///
 AbstractModuleProvider*
 getBytecodeModuleProvider(const std::string &Filename);
 
-///
+/// getBytecodeBufferModuleProvider - lazy function-at-a-time loading from a
+/// buffer
 ///
 AbstractModuleProvider* 
 getBytecodeBufferModuleProvider(const unsigned char *Buffer,
                                 unsigned BufferSize,
-                                const std::string &ModuleID);
+                                const std::string &ModuleID = "");
 
-/// Parse the given bytecode file
+/// ParseBytecodeFile - Parse the given bytecode file
 ///
 Module* ParseBytecodeFile(const std::string &Filename,
                           std::string *ErrorStr = 0);
 
-/// Parse a given bytecode buffer
+/// ParseBytecodeBuffer - Parse a given bytecode buffer
 ///
 Module* ParseBytecodeBuffer(const unsigned char *Buffer,
                             unsigned BufferSize,
-                            const std::string &ModuleID,
+                            const std::string &ModuleID = "",
                             std::string *ErrorStr = 0);
 
 /// ReadArchiveFile - Read bytecode files from the specfied .a file, returning