Remove use of automodule in docs

* One automodule in a file for our modules is way too much, so we split it into
  files. Unfortunately this means that only one file can have those classes and
  functions be linkable from elsewhere.
* Instead we bite the bullet and manually curate the items into pages, and at
  the same time subdivide the 'enums and data' page more which is a general
  readability and usability win as well.
* We also add some previously not-included functions, and add a doc-build time
  check to ensure that functions and classes aren't omitted from the
  documentation in future
This commit is contained in:
baldurk
2020-12-07 17:44:50 +00:00
parent 8a58ba6843
commit df6fec13f9
45 changed files with 1488 additions and 369 deletions
@@ -43,16 +43,11 @@ CaptureSettings::CaptureSettings()
RENDERDOC_GetDefaultCaptureOptions(&options);
}
rdcstr configFilePath(const rdcstr &filename)
rdcstr ConfigFilePath(const rdcstr &filename)
{
return "";
}
ICaptureContext *getCaptureContext(const QWidget *widget)
{
return NULL;
}
////////////////////////////////////////////////////////////////////////////////
// PythonContext.cpp stubs
////////////////////////////////////////////////////////////////////////////////
+12 -1
View File
@@ -264,12 +264,23 @@ TEMPLATE_ARRAY_DECLARE(rdcarray);
%rename("%s") count;
}
%inline %{
%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 ...'.
:param Any object: The object to dump
:return: The string representation of the object.
:rtype: str
)";
%inline %{
extern "C" PyObject *RENDERDOC_DumpObject(PyObject *obj);
%}
%feature("docstring") "";
%extend SDObject {
%feature("docstring") R"(Interprets the object as an integer and returns its value.
Invalid if the object is not actually an integer.