Ensure PersistantConfig member functions are documented

This commit is contained in:
baldurk
2019-10-09 10:25:49 +01:00
parent 3587ec2e77
commit a94f238e37
3 changed files with 7 additions and 2 deletions
+2
View File
@@ -357,6 +357,8 @@ def maybe_skip_member(app, what, name, obj, skip, options):
# as we don't have a way in SWIG to attach docstrings to constants directly.
if 'exclude-members' in options and 'enum_constants__' in options['exclude-members'] and isinstance(obj, int):
return True
if 'exclude-members' in options and 'properties__' in options['exclude-members'] and 'getset_desc' in str(type(obj)):
return True
# Allow arbitrary globbing as a hack to exclude or include members
if 'exclude-members' in options:
for exclude in options['exclude-members']:
+3
View File
@@ -9,6 +9,9 @@ Config
------
.. autoclass:: qrenderdoc.PersistantConfig
:members:
:undoc-members:
:exclude-members: enum_constants__,properties__
.. autoclass:: qrenderdoc.ShaderProcessingTool
:members:
+2 -2
View File
@@ -791,12 +791,12 @@ public:
DOCUMENT(R"(Adds a new remote host.
:param RemoteHost host: The remote host to add.
R)");
)");
void AddRemoteHost(RemoteHost host);
DOCUMENT(R"(Removes an existing remote host.
:param RemoteHost host: The remote host to remove.
R)");
)");
void RemoveRemoteHost(RemoteHost host);
DOCUMENT("If configured, queries available device protocols to update auto-configured hosts.");
void UpdateEnumeratedProtocolDevices();