[Lldb-commits] [lldb] r254790 - Make it clear how you would get the pointee out of an SBValue with

[Jim Ingham via lldb-commits]

Author: jingham
Date: Fri Dec  4 16:51:19 2015
New Revision: 254790

URL: http://llvm.org/viewvc/llvm-project?rev=254790&view=rev
Log:
Make it clear how you would get the pointee out of an SBValue with
GetType().IsPointerType() returns true.

Modified:
    lldb/trunk/include/lldb/API/SBValue.h
    lldb/trunk/scripts/interface/SBValue.i

Modified: lldb/trunk/include/lldb/API/SBValue.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/API/SBValue.h?rev=254790&r1=254789&r2=254790&view=diff
==============================================================================
--- lldb/trunk/include/lldb/API/SBValue.h (original)
+++ lldb/trunk/include/lldb/API/SBValue.h Fri Dec  4 16:51:19 2015
@@ -204,7 +204,11 @@ public:
     /// pointer to a 'Point' type, then the child at index zero will be
     /// the 'x' member, and the child at index 1 will be the 'y' member
     /// (the child at index zero won't be a 'Point' instance).
-    /// 
+    ///
+    /// If you actually need an SBValue that represents the type pointed
+    /// to by a SBValue for which GetType().IsPointeeType() returns true,
+    /// regardless of the pointee type, you can do that with SBValue::Dereference.
+    ///
     /// Arrays have a preset number of children that can be accessed by
     /// index and will returns invalid child values for indexes that are
     /// out of bounds unless the \a synthetic_allowed is \b true. In this

Modified: lldb/trunk/scripts/interface/SBValue.i
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/scripts/interface/SBValue.i?rev=254790&r1=254789&r2=254790&view=diff
==============================================================================
--- lldb/trunk/scripts/interface/SBValue.i (original)
+++ lldb/trunk/scripts/interface/SBValue.i Fri Dec  4 16:51:19 2015
@@ -210,6 +210,11 @@ public:
     /// the 'x' member, and the child at index 1 will be the 'y' member
     /// (the child at index zero won't be a 'Point' instance).
     /// 
+    /// If you actually need an SBValue that represents the type pointed
+    /// to by a SBValue for which GetType().IsPointeeType() returns true,
+    /// regardless of the pointee type, you can do that with the SBValue.Dereference
+    /// method (or the equivalent deref property).
+    ///
     /// Arrays have a preset number of children that can be accessed by
     /// index and will returns invalid child values for indexes that are
     /// out of bounds unless the \a synthetic_allowed is \b true. In this