make the header comment more useful
authorChris Lattner <sabre@nondot.org>
Tue, 30 Sep 2003 17:53:30 +0000 (17:53 +0000)
committerChris Lattner <sabre@nondot.org>
Tue, 30 Sep 2003 17:53:30 +0000 (17:53 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8774 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/ModuleProvider.h

index 8ef74276574ccf0b7ade3d5d31b1170bd9ca5bd2..e8e6052c0f9f537dc2fb67e8a3c9efd2a999d965 100644 (file)
@@ -1,6 +1,10 @@
 //===-- llvm/ModuleProvider.h - Interface for module providers --*- C++ -*-===//
 //
-// Abstract interface for providing a module.
+// This file provides an abstract interface for loading a module from some
+// place.  This interface allows incremental or random access loading of
+// functions from the file.  This is useful for applications like JIT compilers
+// or interprocedural optimizers that do not need the entire program in memory
+// at the same time.
 //
 //===----------------------------------------------------------------------===//
 
@@ -39,7 +43,6 @@ public:
     TheModule = 0; 
     return tempM; 
   }
-
 };
 
 #endif