Add some docstrings for SBFileSpec class.

llvm-svn: 135553
This commit is contained in:
Johnny Chen 2011-07-20 01:06:37 +00:00
parent 869f0b70d4
commit 5cb19e7725
1 changed files with 21 additions and 0 deletions

View File

@ -9,6 +9,27 @@
namespace lldb {
%feature("docstring",
"Represents a file specfication that divides the path into a directory and
basename. The string values of the paths are put into uniqued string pools
for fast comparisons and efficient memory usage.
For example, the following code
lineEntry = context.GetLineEntry()
self.expect(lineEntry.GetFileSpec().GetDirectory(), 'The line entry should have the correct directory',
exe=False,
substrs = [self.mydir])
self.expect(lineEntry.GetFileSpec().GetFilename(), 'The line entry should have the correct filename',
exe=False,
substrs = ['main.c'])
self.assertTrue(lineEntry.GetLine() == self.line,
'The line entry's line number should match ')
gets the line entry from the symbol context when a thread is stopped.
It gets the file spec corresponding to the line entry and checks that
the filename and the directory matches wat we expect.
") SBFileSpec;
class SBFileSpec
{
public: