[Lldb-commits] [lldb] 6df6edf - [lldb][NFC] Document CompilerDeclContext constructors

[Raphael Isemann via lldb-commits]

Author: Raphael Isemann
Date: 2019-12-23T09:59:58+01:00
New Revision: 6df6edfd0a0b50195d56124b9e43bb7c29843b7f

URL: https://github.com/llvm/llvm-project/commit/6df6edfd0a0b50195d56124b9e43bb7c29843b7f
DIFF: https://github.com/llvm/llvm-project/commit/6df6edfd0a0b50195d56124b9e43bb7c29843b7f.diff

LOG: [lldb][NFC] Document CompilerDeclContext constructors

Added: 
    

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

Removed: 
    


################################################################################
diff  --git a/lldb/include/lldb/Symbol/CompilerDeclContext.h b/lldb/include/lldb/Symbol/CompilerDeclContext.h
index d7785ada0ba2..719515242890 100644
--- a/lldb/include/lldb/Symbol/CompilerDeclContext.h
+++ b/lldb/include/lldb/Symbol/CompilerDeclContext.h
@@ -18,9 +18,15 @@ namespace lldb_private {
 
 class CompilerDeclContext {
 public:
-  // Constructors and Destructors
+  /// Constructs an invalid CompilerDeclContext.
   CompilerDeclContext() = default;
 
+  /// Constructs a CompilerDeclContext with the given opaque decl context
+  /// and its respective TypeSystem instance.
+  ///
+  /// Do not use this constructor directly but instead call the respective
+  /// wrapper from the TypeSystem subclass.
+  /// @see lldb_private::ClangASTContext::CreateDeclContext(clang::DeclContext*)
   CompilerDeclContext(TypeSystem *type_system, void *decl_ctx)
       : m_type_system(type_system), m_opaque_decl_ctx(decl_ctx) {}