From 2af257cd0de5cec60d7c62c3c8281d5160bf3eb3 Mon Sep 17 00:00:00 2001
From: Johnny Chen <johnny.chen@apple.com>
Date: Wed, 27 Jul 2011 00:08:59 +0000
Subject: [PATCH] Add deprecation docstrings for some APIs which take an
 SBFrame - SBValues know their own frames.

llvm-svn: 136194
---
 lldb/scripts/Python/interface/SBValue.i | 25 ++++++++++++++++++-------
 1 file changed, 18 insertions(+), 7 deletions(-)

diff --git a/lldb/scripts/Python/interface/SBValue.i b/lldb/scripts/Python/interface/SBValue.i
index c037f1622a66..68e97e3323eb 100644
--- a/lldb/scripts/Python/interface/SBValue.i
+++ b/lldb/scripts/Python/interface/SBValue.i
@@ -82,8 +82,13 @@ public:
     size_t
     GetByteSize ();
 
+    %define DEPRECATED
+    "The method which takes an SBFrame is deprecated - SBValues know their own frames."
+    %enddef
+
+    %feature("docstring", DEPRECATED) IsInScope;
     bool
-    IsInScope (const lldb::SBFrame &frame);  // DEPRECATED - SBValues know their own frames.
+    IsInScope (const lldb::SBFrame &frame);
 
     bool
     IsInScope ();
@@ -94,8 +99,9 @@ public:
     void
     SetFormat (lldb::Format format);
 
+    %feature("docstring", DEPRECATED) GetValue;
     const char *
-    GetValue (const lldb::SBFrame &frame);   // DEPRECATED - SBValues know their own frames.
+    GetValue (const lldb::SBFrame &frame);
 
     const char *
     GetValue ();
@@ -103,32 +109,37 @@ public:
     ValueType
     GetValueType ();
 
+    %feature("docstring", DEPRECATED) GetValueDidChange;
     bool
-    GetValueDidChange (const lldb::SBFrame &frame);  // DEPRECATED - SBValues know their own frames.
+    GetValueDidChange (const lldb::SBFrame &frame);
 
     bool
     GetValueDidChange ();
 
+    %feature("docstring", DEPRECATED) GetSummary;
     const char *
-    GetSummary (const lldb::SBFrame &frame);  // DEPRECATED - SBValues know their own frames.
+    GetSummary (const lldb::SBFrame &frame);
     
     const char *
     GetSummary ();
     
+    %feature("docstring", DEPRECATED) GetObjectDescription;
     const char *
-    GetObjectDescription (const lldb::SBFrame &frame);  // DEPRECATED - SBValues know their own frames.
+    GetObjectDescription (const lldb::SBFrame &frame);
 
     const char *
     GetObjectDescription ();
 
+    %feature("docstring", DEPRECATED) GetLocation;
     const char *
-    GetLocation (const lldb::SBFrame &frame);  // DEPRECATED - SBValues know their own frames.
+    GetLocation (const lldb::SBFrame &frame);
 
     const char *
     GetLocation ();
 
+    %feature("docstring", DEPRECATED) SetValueFromCString;
     bool
-    SetValueFromCString (const lldb::SBFrame &frame, const char *value_str);  // DEPRECATED - SBValues know their own frames.
+    SetValueFromCString (const lldb::SBFrame &frame, const char *value_str);
 
     bool
     SetValueFromCString (const char *value_str);