[Lldb-commits] [lldb] r234923 - Added some documentation for ForEachMacro.

[Sean Callanan]

Author: spyffe
Date: Tue Apr 14 13:50:05 2015
New Revision: 234923

URL: http://llvm.org/viewvc/llvm-project?rev=234923&view=rev
Log:
Added some documentation for ForEachMacro.

Modified:
    lldb/trunk/include/lldb/Expression/ClangModulesDeclVendor.h

Modified: lldb/trunk/include/lldb/Expression/ClangModulesDeclVendor.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/Expression/ClangModulesDeclVendor.h?rev=234923&r1=234922&r2=234923&view=diff
==============================================================================
--- lldb/trunk/include/lldb/Expression/ClangModulesDeclVendor.h (original)
+++ lldb/trunk/include/lldb/Expression/ClangModulesDeclVendor.h Tue Apr 14 13:50:05 2015
@@ -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;
 };