When specifying a built-in type return type, always put it in ``s

This commit is contained in:
baldurk
2017-12-15 17:33:52 +00:00
parent 0c0c2969df
commit de6e95845c
8 changed files with 22 additions and 22 deletions
+6 -6
View File
@@ -297,7 +297,7 @@ struct IResourceInspector
DOCUMENT(R"(Return which resource is currently being inspected.
:return: The ID of the resource being inspected.
:rtype: renderdoc.ResourceId id
:rtype: ~renderdoc.ResourceId
)");
virtual ResourceId CurrentResource() = 0;
@@ -1183,7 +1183,7 @@ in the capture, either a name set via API-specific debug methods, or an auto-gen
the resource type.
:return: The current name of the resource.
:rtype: str
:rtype: ``str``
)");
virtual rdcstr GetResourceName(ResourceId id) = 0;
@@ -1194,7 +1194,7 @@ If not, the name is just auto-generated based on the ID and resource type, so de
circumstance it may be preferable to omit the name.
:return: Whether the name for the resource has just been auto-generated.
:rtype: bool
:rtype: ``bool``
)");
virtual bool IsAutogeneratedName(ResourceId id) = 0;
@@ -1206,7 +1206,7 @@ only check if a name has been set in the UI itself, a resource could still have
was set programmatically during capture time.
:return: Whether the name for the resource has been customised with :meth:`SetResourceCustomName`.
:rtype: bool
:rtype: ``bool``
)");
virtual bool HasResourceCustomName(ResourceId id) = 0;
@@ -1234,7 +1234,7 @@ The index starts at 1, so initialising an internal cache to 0 will cause the fir
considered out of date
:return: An incrementing index that can be used as a quick check if any names have changed.
:rtype: int
:rtype: ``int``
)");
virtual int ResourceNameCacheID() = 0;
@@ -1339,7 +1339,7 @@ Examples of fields are:
:param str key: The name of the notes field to retrieve.
:return: The contents, or an empty string if the field doesn't exist.
:rtype: str
:rtype: ``str``
)");
virtual rdcstr GetNotes(const rdcstr &key) = 0;