[Lldb-commits] [lldb] r141430 - in /lldb/trunk/include/lldb/Core: Module.h ModuleList.h

[Jim Ingham]

Author: jingham
Date: Fri Oct  7 17:28:29 2011
New Revision: 141430

URL: http://llvm.org/viewvc/llvm-project?rev=141430&view=rev
Log:
Clean up some documentation.

Modified:
    lldb/trunk/include/lldb/Core/Module.h
    lldb/trunk/include/lldb/Core/ModuleList.h

Modified: lldb/trunk/include/lldb/Core/Module.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/Core/Module.h?rev=141430&r1=141429&r2=141430&view=diff
==============================================================================
--- lldb/trunk/include/lldb/Core/Module.h (original)
+++ lldb/trunk/include/lldb/Core/Module.h Fri Oct  7 17:28:29 2011
@@ -199,6 +199,11 @@
     //------------------------------------------------------------------
     /// Find functions by name.
     ///
+    /// If the function is an inlined function, it will have a block,
+    /// representing the inlined function, and the function will be the
+    /// containing function.  If it is not inlined, then the block will 
+    /// be NULL.
+    ///
     /// @param[in] name
     ///     The name of the compile unit we are looking for.
     ///
@@ -229,6 +234,11 @@
     //------------------------------------------------------------------
     /// Find functions by name.
     ///
+    /// If the function is an inlined function, it will have a block,
+    /// representing the inlined function, and the function will be the
+    /// containing function.  If it is not inlined, then the block will 
+    /// be NULL.
+    ///
     /// @param[in] regex
     ///     A regular expression to use when matching the name.
     ///

Modified: lldb/trunk/include/lldb/Core/ModuleList.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/Core/ModuleList.h?rev=141430&r1=141429&r2=141430&view=diff
==============================================================================
--- lldb/trunk/include/lldb/Core/ModuleList.h (original)
+++ lldb/trunk/include/lldb/Core/ModuleList.h Fri Oct  7 17:28:29 2011
@@ -166,26 +166,7 @@
                       SymbolContextList &sc_list);
     
     //------------------------------------------------------------------
-    /// Find functions by name.
-    ///
-    /// Finds all functions that match \a name in all of the modules and
-    /// returns the results in \a sc_list.
-    ///
-    /// @param[in] name
-    ///     The name of the function we are looking for.
-    ///
-    /// @param[in] name_type_mask
-    ///     A bit mask of bits that indicate what kind of names should
-    ///     be used when doing the lookup. Bits include fully qualified
-    ///     names, base names, C++ methods, or ObjC selectors. 
-    ///     See FunctionNameType for more details.
-    ///
-    /// @param[out] sc_list
-    ///     A symbol context list that gets filled in with all of the
-    ///     matches.
-    ///
-    /// @return
-    ///     The number of matches added to \a sc_list.
+    /// @see Module::FindFunctions ()
     //------------------------------------------------------------------
     uint32_t
     FindFunctions (const ConstString &name,