[Lldb-commits] [lldb] 1695dd1 - [lldb][NFC] Fix documentation for EncodingDataType

[Luís Ferreira via lldb-commits]

Author: Luís Ferreira
Date: 2021-12-14T20:13:30Z
New Revision: 1695dd17524264a199d3731afe8e786bd1ce58c8

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

LOG: [lldb][NFC] Fix documentation for EncodingDataType

Reviewed By: teemperor

Differential Revision: https://reviews.llvm.org/D113605

Added: 
    

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

Removed: 
    


################################################################################
diff  --git a/lldb/include/lldb/Symbol/Type.h b/lldb/include/lldb/Symbol/Type.h
index 6f89814c86a75..7754e02990964 100644
--- a/lldb/include/lldb/Symbol/Type.h
+++ b/lldb/include/lldb/Symbol/Type.h
@@ -66,6 +66,7 @@ class SymbolFileType : public std::enable_shared_from_this<SymbolFileType>,
 class Type : public std::enable_shared_from_this<Type>, public UserID {
 public:
   enum EncodingDataType {
+    /// Invalid encoding.
     eEncodingInvalid,
     /// This type is the type whose UID is m_encoding_uid.
     eEncodingIsUID,
@@ -78,7 +79,7 @@ class Type : public std::enable_shared_from_this<Type>, public UserID {
     /// This type is the type whose UID is m_encoding_uid with the volatile
     /// qualifier added.
     eEncodingIsVolatileUID,
-    /// This type is pointer to a type whose UID is m_encoding_uid.
+    /// This type is alias to a type whose UID is m_encoding_uid.
     eEncodingIsTypedefUID,
     /// This type is pointer to a type whose UID is m_encoding_uid.
     eEncodingIsPointerUID,
@@ -88,6 +89,7 @@ class Type : public std::enable_shared_from_this<Type>, public UserID {
     eEncodingIsRValueReferenceUID,
     /// This type is the type whose UID is m_encoding_uid as an atomic type.
     eEncodingIsAtomicUID,
+    /// This type is the synthetic type whose UID is m_encoding_uid.
     eEncodingIsSyntheticUID
   };