search

hakril / PythonForWindows

A codebase aimed to make interaction with Windows and native execution easier
BSD 3-Clause "New" or "Revised" License
573 stars 112 forks source link

[DOC] FunctionCallBP not documented #13

Closed BrunoPujos closed 4 years ago

BrunoPujos commented 4 years ago

The class windows.debug.FunctionCallBP (breakpoints.py) does not seems to be documented. This is the parent class of windows.debug.FunctionBP. This class is useful when putting "by hand" a breakpoint on the start of a function and want to manipulate its return value when we do not have symbols or don't know the argument of the function. Simple example and documentation could be a potential improvement for this.

hakril commented 4 years ago

Hi, Thank you for the issue. Indeed FunctionCallBP can proove userful in some case. I have added a sample based on this feature and also added windows.debug.FunctionCallBP to the debug.rst doc file. The documentation will be updated om the online documentation the next time I merge master.

I am closing this issue, feel free to re-open it if you feel the sample is not descritive enought of the features you had in mind.