Add a spellchecking mode for sphinx and fix some typos

* The worst one was Persistant -> Persistent. This involved renaming
  PersistentConfig but the impact of that is considered minimal enough to be
  worth fixing.
This commit is contained in:
baldurk
2026-08-13 17:46:47 +01:00
parent 5e462c5ebe
commit bb4017a965
75 changed files with 653 additions and 248 deletions
@@ -431,7 +431,7 @@ void PythonContext::PrepareDebugTracing()
}
}
void PythonContext::GlobalInit(PersistantConfig &config)
void PythonContext::GlobalInit(PersistentConfig &config)
{
// must happen on the UI thread
if(qApp->thread() != QThread::currentThread())
@@ -2375,7 +2375,7 @@ bool PythonContext::WaitForDebugger()
return ret;
}
void PythonContext::LaunchDebugger(QWidget *window, PersistantConfig &config, QString context_location)
void PythonContext::LaunchDebugger(QWidget *window, PersistentConfig &config, QString context_location)
{
if(!m_DebugPy)
return;
+2 -2
View File
@@ -62,7 +62,7 @@ public:
void PausePythonThreading();
void ResumePythonThreading();
static void GlobalInit(PersistantConfig &config);
static void GlobalInit(PersistentConfig &config);
static void GlobalShutdown();
static QStringList GetApplicationExtensionsPaths();
@@ -81,7 +81,7 @@ public:
static void PrepareDebuggerWait();
static bool WaitForDebugger();
static void LaunchDebugger(QWidget *window, PersistantConfig &config, QString context_location);
static void LaunchDebugger(QWidget *window, PersistentConfig &config, QString context_location);
PyParseError CheckPyParse(const QByteArray &script, const rdcstr &scriptNameForErrors);
@@ -1448,7 +1448,7 @@ struct CaptureContextInvoker : UIThreadInvoker<ICaptureContext>
return m_Obj.CurVulkanPipelineState();
}
virtual const PipeState &CurPipelineState() override { return m_Obj.CurPipelineState(); }
virtual PersistantConfig &Config() override { return m_Obj.Config(); }
virtual PersistentConfig &Config() override { return m_Obj.Config(); }
//
///////////////////////////////////////////////////////////////////////
// functions that invoke onto the UI thread
@@ -68,7 +68,7 @@ inline bool checkname(rdcstr &log, const char *baseType, rdcstr name, NameType n
return false;
// allow the config to have different names
if((baseType && strstr(baseType, "PersistantConfig")) || name.contains("PersistantConfig"))
if((baseType && strstr(baseType, "PersistentConfig")) || name.contains("PersistentConfig"))
return false;
// skip swig internal type
+1 -1
View File
@@ -171,7 +171,7 @@ SWIGPY_DESTRUCTOR_CLOSURE(capviewer_deinit) /* defines capviewer_deinit_destruct
%include <stdint.i>
%include "Code/Interface/QRDInterface.h"
%include "Code/Interface/PersistantConfig.h"
%include "Code/Interface/PersistentConfig.h"
%include "Code/Interface/RemoteHost.h"
%include "Code/Interface/Extensions.h"
+13 -13
View File
@@ -93,7 +93,7 @@ ShaderToolOutput ShaderProcessingTool::CompileShader(QWidget *window, rdcstr sou
}
////////////////////////////////////////////////////////////////////////////////
// PersistantConfig.cpp stubs
// PersistentConfig.cpp stubs
////////////////////////////////////////////////////////////////////////////////
rdcstr BugReport::URL() const
@@ -101,56 +101,56 @@ rdcstr BugReport::URL() const
return "";
}
bool PersistantConfig::SetStyle()
bool PersistentConfig::SetStyle()
{
return false;
}
PersistantConfig::PersistantConfig()
PersistentConfig::PersistentConfig()
{
}
PersistantConfig::~PersistantConfig()
PersistentConfig::~PersistentConfig()
{
}
bool PersistantConfig::Load(const rdcstr &filename)
bool PersistentConfig::Load(const rdcstr &filename)
{
return false;
}
bool PersistantConfig::Save()
bool PersistentConfig::Save()
{
return false;
}
void PersistantConfig::Close()
void PersistentConfig::Close()
{
}
rdcarray<RemoteHost> PersistantConfig::GetRemoteHosts()
rdcarray<RemoteHost> PersistentConfig::GetRemoteHosts()
{
return {};
}
RemoteHost PersistantConfig::GetRemoteHost(const rdcstr &)
RemoteHost PersistentConfig::GetRemoteHost(const rdcstr &)
{
return RemoteHost();
}
void PersistantConfig::AddRemoteHost(RemoteHost host)
void PersistentConfig::AddRemoteHost(RemoteHost host)
{
}
void PersistantConfig::RemoveRemoteHost(RemoteHost host)
void PersistentConfig::RemoveRemoteHost(RemoteHost host)
{
}
void PersistantConfig::UpdateEnumeratedProtocolDevices()
void PersistentConfig::UpdateEnumeratedProtocolDevices()
{
}
void PersistantConfig::SetupFormatting()
void PersistentConfig::SetupFormatting()
{
}
+2 -2
View File
@@ -319,8 +319,8 @@ TEMPLATE_FIXEDARRAY_DECLARE(rdcfixedarray);
}
%feature("docstring") R"(Returns a string representation of an object. This is quite similar to
the built-in repr() function but it iterates over struct members and prints them out, where normally
repr() would stop and say something like 'Swig Object of type ...'.
the built-in ``repr()`` function but it iterates over struct members and prints them out, where normally
``repr()`` would stop and say something like 'Swig Object of type ...'.
:param Any obj: The object to dump
:return: The string representation of the object.