From a94f238e37cfe2f142093eb8e5da7775abaa88c6 Mon Sep 17 00:00:00 2001 From: baldurk Date: Wed, 9 Oct 2019 10:25:49 +0100 Subject: [PATCH] Ensure PersistantConfig member functions are documented --- docs/conf.py | 2 ++ docs/python_api/qrenderdoc/config.rst | 3 +++ qrenderdoc/Code/Interface/PersistantConfig.h | 4 ++-- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 354acd3e7..219933c27 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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']: diff --git a/docs/python_api/qrenderdoc/config.rst b/docs/python_api/qrenderdoc/config.rst index 9d9e568b2..d2d73d4b8 100644 --- a/docs/python_api/qrenderdoc/config.rst +++ b/docs/python_api/qrenderdoc/config.rst @@ -9,6 +9,9 @@ Config ------ .. autoclass:: qrenderdoc.PersistantConfig + :members: + :undoc-members: + :exclude-members: enum_constants__,properties__ .. autoclass:: qrenderdoc.ShaderProcessingTool :members: diff --git a/qrenderdoc/Code/Interface/PersistantConfig.h b/qrenderdoc/Code/Interface/PersistantConfig.h index 6838c9584..0394fcbe1 100644 --- a/qrenderdoc/Code/Interface/PersistantConfig.h +++ b/qrenderdoc/Code/Interface/PersistantConfig.h @@ -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();