lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-07-08 08:40:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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 12:42:35 +00:00
parent e5f4ca7bb8
commit 6b8ce92d88
33 changed files with 1178 additions and 592 deletions
Download Patch File Download Diff File Expand all files Collapse all files
qrenderdoc/Code/MiniQtHelper.cpp
+7 -7
View File
@@ -136,7 +136,7 @@ QWidget *MiniQtHelper::GetParent(QWidget *widget)
return widget->parentWidget();
}
int MiniQtHelper::GetNumChildren(QWidget *widget)
int32_t MiniQtHelper::GetNumChildren(QWidget *widget)
{
if(!widget)
return 0;
@@ -148,7 +148,7 @@ int MiniQtHelper::GetNumChildren(QWidget *widget)
return layout->count();
}
QWidget *MiniQtHelper::GetChild(QWidget *parent, int index)
QWidget *MiniQtHelper::GetChild(QWidget *parent, int32_t index)
{
if(!parent)
return NULL;
@@ -249,8 +249,8 @@ void MiniQtHelper::ClearContainedWidgets(QWidget *parent)
}
}
void MiniQtHelper::AddGridWidget(QWidget *parent, int row, int column, QWidget *child, int rowSpan,
int columnSpan)
void MiniQtHelper::AddGridWidget(QWidget *parent, int32_t row, int32_t column, QWidget *child,
int32_t rowSpan, int32_t columnSpan)
{
if(!parent || !child)
return;
@@ -282,7 +282,7 @@ void MiniQtHelper::AddWidget(QWidget *parent, QWidget *child)
box->addWidget(child);
}
void MiniQtHelper::InsertWidget(QWidget *parent, int index, QWidget *child)
void MiniQtHelper::InsertWidget(QWidget *parent, int32_t index, QWidget *child)
{
if(!parent)
return;
@@ -384,7 +384,7 @@ rdcstr MiniQtHelper::GetWidgetText(QWidget *widget)
return widget->windowTitle();
}
void MiniQtHelper::SetWidgetFont(QWidget *widget, const rdcstr &font, int fontSize, bool bold,
void MiniQtHelper::SetWidgetFont(QWidget *widget, const rdcstr &font, int32_t fontSize, bool bold,
bool italic)
{
if(!widget)
@@ -555,7 +555,7 @@ bool MiniQtHelper::IsWidgetChecked(QWidget *checkableWidget)
return false;
}
QWidget *MiniQtHelper::CreateSpinbox(int decimalPlaces, double step)
QWidget *MiniQtHelper::CreateSpinbox(int32_t decimalPlaces, double step)
{
RDDoubleSpinBox *ret = new RDDoubleSpinBox();
ret->setSingleStep(step);