[Lldb-commits] [lldb] 3618381 - Clarify comment

[Adrian Prantl via lldb-commits]

Author: Adrian Prantl
Date: 2020-05-04T18:15:30-07:00
New Revision: 36183811fb5455ea18cf7d9cd03748076f20573b

URL: https://github.com/llvm/llvm-project/commit/36183811fb5455ea18cf7d9cd03748076f20573b
DIFF: https://github.com/llvm/llvm-project/commit/36183811fb5455ea18cf7d9cd03748076f20573b.diff

LOG: Clarify comment

Added: 
    

Modified: 
    lldb/include/lldb/Symbol/SymbolFile.h

Removed: 
    


################################################################################
diff  --git a/lldb/include/lldb/Symbol/SymbolFile.h b/lldb/include/lldb/Symbol/SymbolFile.h
index bc2b6b8f212e..86c8af665d32 100644
--- a/lldb/include/lldb/Symbol/SymbolFile.h
+++ b/lldb/include/lldb/Symbol/SymbolFile.h
@@ -136,12 +136,16 @@ class SymbolFile : public PluginInterface {
   /// \p comp_unit. Recursively also descends into the referenced external
   /// modules of any encountered compilation unit.
   ///
+  /// This function can be used to traverse Clang -gmodules debug
+  /// information, which is stored in DWARF files separate from the
+  /// object files.
+  ///
   /// \param comp_unit
   ///     When this SymbolFile consists of multiple auxilliary
   ///     SymbolFiles, for example, a Darwin debug map that references
   ///     multiple .o files, comp_unit helps choose the auxilliary
   ///     file. In most other cases comp_unit's symbol file is
-  ///     identiacal with *this.
+  ///     identical with *this.
   ///
   /// \param[in] lambda
   ///     The lambda that should be applied to every function. The lambda can