Improve documentation of getPointeeType()

llvm · Jan 13, 2025 · f0350e1 · f0350e1
1 parent 40eddf9
commit f0350e1
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/clang/include/clang/AST/Type.h b/clang/include/clang/AST/Type.h
@@ -2871,8 +2871,15 @@ class alignas(TypeAlignment) Type : public ExtQualsTypeCommonBase {
   /// This should never be used when type qualifiers are meaningful.
   const Type *getPointerOrObjCPointerOrArrayElementType() const;
 
-  /// If this is a pointer, ObjC object pointer, or block
-  /// pointer, this returns the respective pointee.
+  /// Return the 'pointee type' for any of the following kinds of types,
+  /// and an empty QualType otherwise.
+  ///
+  ///   - PointerType
+  ///   - ObjCObjectPointerType
+  ///   - BlockPointerType
+  ///   - ReferenceType
+  ///   - MemberPointerType
+  ///   - DecayedType
   QualType getPointeeType() const;
 
   /// Return the specified type with any "sugar" removed from the type,