Added some documentation for ForEachMacro.

llvm-svn: 234923

diff --git a/lldb/include/lldb/Expression/ClangModulesDeclVendor.h b/lldb/include/lldb/Expression/ClangModulesDeclVendor.h
index 1466027..5bc383d 100644 (file)
--- a/lldb/include/lldb/Expression/ClangModulesDeclVendor.h
+++ b/lldb/include/lldb/Expression/ClangModulesDeclVendor.h
@@ -53,6 +53,14 @@ public:
     virtual bool
     AddModule(std::vector<llvm::StringRef> &path, Stream &error_stream) = 0;
     
+    //------------------------------------------------------------------
+    /// Enumerate all the macros that are currently visible.
+    ///
+    /// @param[in] handler
+    ///     A function that receives the text of each #define macro.
+    ///     If handler returns true, this function returns immediately,
+    ///     without calling handler again.
+    //------------------------------------------------------------------
     virtual void
     ForEachMacro(std::function<bool (const std::string &)> handler) = 0;
 };