Add some comments explaining what MVT and EVT are, and how they differ.
[oota-llvm.git] / include / llvm / System / DynamicLibrary.h
index f04734a6f9bcd8fe98c7262c97cccd90ce84655a..745b8f8b5b4b11c29d138a9a6cc6675e069392f9 100644 (file)
@@ -23,7 +23,7 @@ namespace sys {
   /// might be known as shared libraries, shared objects, dynamic shared
   /// objects, or dynamic link libraries. Regardless of the terminology or the
   /// operating system interface, this class provides a portable interface that
-  /// allows dynamic libraries to be loaded and and searched for externally
+  /// allows dynamic libraries to be loaded and searched for externally
   /// defined symbols. This is typically used to provide "plug-in" support.
   /// It also allows for symbols to be defined which don't live in any library,
   /// but rather the main program itself, useful on Windows where the main
@@ -36,6 +36,9 @@ namespace sys {
     /// and will only be unloaded when the program terminates.  This returns
     /// false on success or returns true and fills in *ErrMsg on failure.
     /// @brief Open a dynamic library permanently.
+    ///
+    /// NOTE: This function is not thread safe.
+    ///
     static bool LoadLibraryPermanently(const char *filename,
                                        std::string *ErrMsg = 0);
 
@@ -46,9 +49,15 @@ namespace sys {
     /// as ephemerally loaded libraries (constructors).
     /// @throws std::string on error.
     /// @brief Search through libraries for address of a symbol
+    ///
+    /// NOTE: This function is not thread safe.
+    ///
     static void *SearchForAddressOfSymbol(const char *symbolName);
 
     /// @brief Convenience function for C++ophiles.
+    ///
+    /// NOTE: This function is not thread safe.
+    ///
     static void *SearchForAddressOfSymbol(const std::string &symbolName) {
       return SearchForAddressOfSymbol(symbolName.c_str());
     }
@@ -57,9 +66,15 @@ namespace sys {
     /// value \p symbolValue.  These symbols are searched before any
     /// libraries.
     /// @brief Add searchable symbol/value pair.
+    ///
+    /// NOTE: This function is not thread safe.
+    ///
     static void AddSymbol(const char *symbolName, void *symbolValue);
 
     /// @brief Convenience function for C++ophiles.
+    ///
+    /// NOTE: This function is not thread safe.
+    ///
     static void AddSymbol(const std::string &symbolName, void *symbolValue) {
       AddSymbol(symbolName.c_str(), symbolValue);
     }