Add comments to function.

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

diff --git a/lib/VMCore/Module.cpp b/lib/VMCore/Module.cpp
index d4432c6ed955e27d9fd011ee61827a9a84f85297..b7bb49184b0b04089e96c3a608751be59f478ffa 100644 (file)
--- a/lib/VMCore/Module.cpp
+++ b/lib/VMCore/Module.cpp
@@ -224,6 +224,12 @@ GlobalVariable *Module::getGlobalVariable(const std::string &Name,
   return 0;
 }
 
+/// getOrInsertGlobal - Look up the specified global in the module symbol table.
+///   1. If it does not exist, add a declaration of the global and return it.
+///   2. Else, the global exists but has the wrong type: return the function
+///      with a constantexpr cast to the right type.
+///   3. Finally, if the existing global is the correct delclaration, return the
+///      existing global.
 Constant *Module::getOrInsertGlobal(const std::string &Name, const Type *Ty) {
   ValueSymbolTable &SymTab = getValueSymbolTable();