[pykd] added : docstrings added for all fucntions. My congratulations

git-svn-id: https://pykd.svn.codeplex.com/svn@63947 9b283d60-5439-405e-af05-b73fd8c4d996
This commit is contained in:
SND\kernelnet_cp 2011-04-13 15:51:54 +00:00
parent 30d291750a
commit 3041ac3fdb
2 changed files with 30 additions and 18 deletions

View File

@ -246,28 +246,40 @@ BOOST_PYTHON_MODULE( pykd )
boost::python::class_<dbgExtensionClass>( boost::python::class_<dbgExtensionClass>(
"ext", "ext",
"windbg extension", "windbg extension wrapper",
boost::python::init<const char*>( boost::python::args("path"), "__init__ dbgExtensionClass" ) ) boost::python::init<const char*>( boost::python::args("path"), "__init__ dbgExtensionClass" ) )
.def("call", &dbgExtensionClass::call ) .def("call", &dbgExtensionClass::call,
.def("__str__", &dbgExtensionClass::print ); "Call extension command" )
boost::python::class_<dbgStackFrameClass>( "dbgStackFrameClass", "dbgStackFrameClass" ) .def("__str__", &dbgExtensionClass::print,
.def_readonly( "instructionOffset", &dbgStackFrameClass::InstructionOffset ) "Return a nice string represention of the dbgExtensionClass" );
.def_readonly( "returnOffset", &dbgStackFrameClass::ReturnOffset ) boost::python::class_<dbgStackFrameClass>( "dbgStackFrameClass",
.def_readonly( "frameOffset", &dbgStackFrameClass::FrameOffset ) "Class representing a frame of the call satck" )
.def_readonly( "stackOffset", &dbgStackFrameClass::StackOffset ) .def_readonly( "instructionOffset", &dbgStackFrameClass::InstructionOffset,
.def_readonly( "frameNumber", &dbgStackFrameClass::FrameNumber ) "Return a frame's instruction offset" )
.def( "__str__", &dbgStackFrameClass::print ); .def_readonly( "returnOffset", &dbgStackFrameClass::ReturnOffset,
"Return a frame's return offset" )
.def_readonly( "frameOffset", &dbgStackFrameClass::FrameOffset,
"Return a frame's offset" )
.def_readonly( "stackOffset", &dbgStackFrameClass::StackOffset,
"Return a frame's stack offset" )
.def_readonly( "frameNumber", &dbgStackFrameClass::FrameNumber,
"Return a frame's number" )
.def( "__str__", &dbgStackFrameClass::print,
"Return a nice string represention of the dbgStackFrameClass" );
boost::python::class_<dbgOut>( "windbgOut", "windbgOut" ) boost::python::class_<dbgOut>( "windbgOut", "windbgOut" )
.def( "write", &dbgOut::write ); .def( "write", &dbgOut::write );
boost::python::class_<dbgIn>( "windbgIn", "windbgIn" ) boost::python::class_<dbgIn>( "windbgIn", "windbgIn" )
.def( "readline", &dbgIn::readline ); .def( "readline", &dbgIn::readline );
boost::python::class_<dbgBreakpointClass>( boost::python::class_<dbgBreakpointClass>( "bp",
"bp", "Class representing breakpoint",
"break point", boost::python::init<ULONG64,boost::python::object&>( boost::python::args("offset", "callback"),
boost::python::init<ULONG64,boost::python::object&>( boost::python::args("offset", "callback"), "__init__ dbgBreakpointClass" ) ) "dbgBreakpointClass constructor" ) )
.def( "set", &dbgBreakpointClass::set ) .def( "set", &dbgBreakpointClass::set,
.def( "remove", &dbgBreakpointClass::remove ) "Set a breakpoint at the specified address" )
.def( "__str__", &dbgBreakpointClass::print ); .def( "remove", &dbgBreakpointClass::remove,
"Remove a breakpoint set before" )
.def( "__str__", &dbgBreakpointClass::print,
"Return a nice string represention of the breakpoint class" );
// debug status // debug status
_DEF_PY_CONST(DEBUG_STATUS_NO_CHANGE); _DEF_PY_CONST(DEBUG_STATUS_NO_CHANGE);

View File

@ -124,7 +124,7 @@ DbgPythonPath::findPath(
if ( bufSize > 0 ) if ( bufSize > 0 )
{ {
bufSize += 1; bufSize += 1;
std::vector<char> fullFileNameCStr(bufSize); std::vector<char> fullFileNameCStr(bufSize);
char *partFileNameCStr = NULL; char *partFileNameCStr = NULL;
bufSize = SearchPathA( bufSize = SearchPathA(