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 -6
View File
@@ -2000,11 +2000,6 @@ void CaptureContext::SetResourceCustomName(ResourceId id, const rdcstr &name)
RefreshUIStatus({}, true, true);
}
int CaptureContext::ResourceNameCacheID()
{
return m_CustomNameCachedID;
}
#if defined(RENDERDOC_PLATFORM_APPLE)
extern "C" void *makeNSViewMetalCompatible(void *handle);
#endif
@@ -2459,7 +2454,7 @@ IConstantBufferPreviewer *CaptureContext::ViewConstantBuffer(ShaderStage stage,
return new ConstantBufferPreviewer(*this, stage, slot, idx, m_MainWindow);
}
IPixelHistoryView *CaptureContext::ViewPixelHistory(ResourceId texID, int x, int y,
IPixelHistoryView *CaptureContext::ViewPixelHistory(ResourceId texID, uint32_t x, uint32_t y,
const TextureDisplay &display)
{
return new PixelHistoryView(*this, texID, QPoint(x, y), display, m_MainWindow);