[Lldb-commits] [lldb] f14680c - [lldb][NFC] Documention that OptionDefinition::completion_type contains enum values

[Raphael Isemann via lldb-commits]

Author: Raphael Isemann
Date: 2020-02-18T10:33:38+01:00
New Revision: f14680ce29663d098593e2f4e0eea96dbcaae0fb

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

LOG: [lldb][NFC] Documention that OptionDefinition::completion_type contains enum values

This should be just the enum type but that's a larger refactoring, so document that
this is not just an integer until we can make this just the type of the enum.

Added: 
    

Modified: 
    lldb/include/lldb/lldb-private-types.h

Removed: 
    


################################################################################
diff  --git a/lldb/include/lldb/lldb-private-types.h b/lldb/include/lldb/lldb-private-types.h
index 2034c6c17909..fb8c2db2e21c 100644
--- a/lldb/include/lldb/lldb-private-types.h
+++ b/lldb/include/lldb/lldb-private-types.h
@@ -124,7 +124,8 @@ struct OptionDefinition {
   OptionValidator *validator;
   /// If not empty, an array of enum values.
   OptionEnumValues enum_values;
-  /// Cookie the option class can use to do define the argument completion.
+  /// The kind of completion for this option.
+  /// Contains values of the CommandCompletions::CommonCompletionTypes enum.
   uint32_t completion_type;
   /// Type of argument this option takes.
   lldb::CommandArgumentType argument_type;