Clean up docstrings in python interfaces to be strictly typed/formatted

* Also added a script that can run as part of CI to verify that the docstring
  matches, by generating a regex from the docstring documented parameter types
  and return type and making sure we find a match within the C headers. This
  ensures all parameters are documented with the right types, no extra
  parameters are documented, and the return type is correct.
* The script also checks proper scoping so that if qrenderdoc docstrings
  mention a renderdoc type, they need to scope it properly.
This commit is contained in:
baldurk
2020-12-07 17:44:51 +00:00
parent e5f4ca7bb8
commit 6b8ce92d88
33 changed files with 1178 additions and 592 deletions
+1 -1
View File
@@ -3916,7 +3916,7 @@ void ShaderViewer::SetCurrentStep(uint32_t step)
updateDebugState();
}
void ShaderViewer::ToggleBreakpoint(int instruction)
void ShaderViewer::ToggleBreakpoint(int32_t instruction)
{
if(!m_Trace || m_States.empty())
return;