intel/llvm
1
0
Fork 0
mirror of https://github.com/intel/llvm.git synced 2026-01-19 17:45:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add some docstrings for SBStream class.

Browse Source 
llvm-svn: 135536
This commit is contained in:
Johnny Chen
2011-07-19 23:24:36 +00:00
parent ccf243d56b
commit e012858bd6
1 changed files with 47 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
lldb/scripts/Python/interface/SBStream.i
View File

@@ -11,6 +11,33 @@
namespace lldb {
%feature("docstring",
"Represents a destination for streaming data output to. By default, a string
stream is created.
For example (from test/source-manager/TestSourceManager.py),
# Create the filespec for 'main.c'.
filespec = lldb.SBFileSpec('main.c', False)
source_mgr = self.dbg.GetSourceManager()
# Use a string stream as the destination.
stream = lldb.SBStream()
source_mgr.DisplaySourceLinesWithLineNumbers(filespec,
self.line,
2, # context before
2, # context after
'=>', # prefix for current line
stream)
# 2
# 3 int main(int argc, char const *argv[]) {
# => 4 printf('Hello world.\\n'); // Set break point at this line.
# 5 return 0;
# 6 }
self.expect(stream.GetData(), 'Source code displayed correctly',
exe=False,
patterns = ['=> %d.*Hello world' % self.line])
") SBStream;
class SBStream
{
public:
@@ -22,14 +49,22 @@ public:
bool
IsValid() const;
// If this stream is not redirected to a file, it will maintain a local
// cache for the stream data which can be accessed using this accessor.
%feature("docstring", "
//--------------------------------------------------------------------------
/// If this stream is not redirected to a file, it will maintain a local
/// cache for the stream data which can be accessed using this accessor.
//--------------------------------------------------------------------------
") GetData;
const char *
GetData ();
// If this stream is not redirected to a file, it will maintain a local
// cache for the stream output whose length can be accessed using this
// accessor.
%feature("docstring", "
//--------------------------------------------------------------------------
/// If this stream is not redirected to a file, it will maintain a local
/// cache for the stream output whose length can be accessed using this
/// accessor.
//--------------------------------------------------------------------------
") GetSize;
size_t
GetSize();
@@ -45,9 +80,13 @@ public:
void
RedirectToFileDescriptor (int fd, bool transfer_fh_ownership);
// If the stream is redirected to a file, forget about the file and if
// ownership of the file was transfered to this object, close the file.
// If the stream is backed by a local cache, clear this cache.
%feature("docstring", "
//--------------------------------------------------------------------------
/// If the stream is redirected to a file, forget about the file and if
/// ownership of the file was transfered to this object, close the file.
/// If the stream is backed by a local cache, clear this cache.
//--------------------------------------------------------------------------
") Clear;
void
Clear ();
};