docs: use glob pattern to match source code docs (#1918)

docs/source/source/src/platform.rst

@@ -1,10 +0,0 @@
-platform
-========
-
-.. toctree::
-   :maxdepth: 1
-
-   platform/common
-   platform/linux
-   platform/macos
-   platform/windows

docs/source/source/src/platform/linux.rst

@@ -1,12 +0,0 @@
-linux
-=====
-
-.. toctree::
-   :maxdepth: 1
-
-   linux/cuda
-   linux/graphics
-   linux/misc
-   linux/vaapi
-   linux/wayland
-   linux/x11grab

docs/source/source/src/platform/macos.rst

@@ -1,11 +0,0 @@
-macos
-=====
-
-.. toctree::
-   :maxdepth: 1
-
-   macos/av_audio
-   macos/av_img_t
-   macos/av_video
-   macos/misc
-   macos/nv12_zero_device

docs/source/source/src/platform/windows.rst

@@ -1,9 +0,0 @@
-windows
-=======
-
-.. toctree::
-   :maxdepth: 1
-
-   windows/display
-   windows/misc
-   windows/PolicyConfig

docs/source/source_code/source_code.rst

@@ -0,0 +1,91 @@
+Source Code
+===========
+We are in process of improving the source code documentation. Code should be documented using Doxygen syntax.
+Some examples exist in `main.h` and `main.cpp`. In order for documentation within the code to appear in the
+rendered docs, the definition of the object must be in a header file, although the documentation itself can (and
+should) be in the source file.
+
+Example Documentation Blocks
+----------------------------
+
+**file.h**
+
+.. code-block:: c
+
+   // functions
+   int main(int argc, char *argv[]);
+
+**file.cpp** (with markdown)
+
+.. code-block:: cpp
+
+   /**
+    * @brief Main application entry point.
+    * @param argc The number of arguments.
+    * @param argv The arguments.
+    *
+    * EXAMPLES:
+    * ```cpp
+    * main(1, const char* args[] = {"hello", "markdown", nullptr});
+    * ```
+    */
+   int main(int argc, char *argv[]) {
+     // do stuff
+   }
+
+**file.cpp** (with ReStructuredText)
+
+.. code-block:: cpp
+
+   /**
+    * @brief Main application entry point.
+    * @param argc The number of arguments.
+    * @param argv The arguments.
+    * @rst
+    * EXAMPLES:
+    *
+    * .. code-block:: cpp
+    *    main(1, const char* args[] = {"hello", "rst", nullptr});
+    * @endrst
+    */
+   int main(int argc, char *argv[]) {
+     // do stuff
+   }
+
+Source
+------
+
+.. toctree::
+   :caption: src
+   :maxdepth: 1
+   :glob:
+
+   src/*
+
+.. toctree::
+   :caption: src/platform
+   :maxdepth: 1
+   :glob:
+
+   src/platform/*
+
+.. toctree::
+   :caption: src/platform/linux
+   :maxdepth: 1
+   :glob:
+
+   src/platform/linux/*
+
+.. toctree::
+   :caption: src/platform/macos
+   :maxdepth: 1
+   :glob:
+
+   src/platform/macos/*
+
+.. toctree::
+   :caption: src/platform/windows
+   :maxdepth: 1
+   :glob:
+
+   src/platform/windows/*

docs/source/source_code/src/audio.rst

@@ -0,0 +1,5 @@
+audio
+=====
+
+.. doxygenfile:: audio.h
+   :allow-dot-graphs:

docs/source/source_code/src/cbs.rst

@@ -0,0 +1,5 @@
+cbs
+===
+
+.. doxygenfile:: cbs.h
+   :allow-dot-graphs:

docs/source/source_code/src/config.rst

@@ -0,0 +1,5 @@
+config
+======
+
+.. doxygenfile:: config.h
+   :allow-dot-graphs:

docs/source/source_code/src/confighttp.rst

@@ -0,0 +1,5 @@
+confighttp
+==========
+
+.. doxygenfile:: confighttp.h
+   :allow-dot-graphs:

docs/source/source_code/src/crypto.rst

@@ -0,0 +1,5 @@
+crypto
+======
+
+.. doxygenfile:: crypto.h
+   :allow-dot-graphs:

docs/source/source_code/src/httpcommon.rst

@@ -0,0 +1,5 @@
+httpcommon
+==========
+
+.. doxygenfile:: httpcommon.h
+   :allow-dot-graphs:

docs/source/source_code/src/input.rst

@@ -0,0 +1,5 @@
+input
+=====
+
+.. doxygenfile:: input.h
+   :allow-dot-graphs:

docs/source/source_code/src/main.rst

@@ -0,0 +1,5 @@
+main
+====
+
+.. doxygenfile:: main.h
+   :allow-dot-graphs:

docs/source/source_code/src/move_by_copy.rst

@@ -0,0 +1,5 @@
+move_by_copy
+============
+
+.. doxygenfile:: move_by_copy.h
+   :allow-dot-graphs:

docs/source/source_code/src/network.rst

@@ -0,0 +1,5 @@
+network
+=======
+
+.. doxygenfile:: network.h
+   :allow-dot-graphs:

docs/source/source_code/src/nvhttp.rst

@@ -0,0 +1,5 @@
+nvhttp
+======
+
+.. doxygenfile:: nvhttp.h
+   :allow-dot-graphs:

docs/source/source_code/src/platform/common.rst

@@ -0,0 +1,4 @@
+common
+======
+
+.. Todo:: Add common.h

docs/source/source_code/src/platform/linux/cuda.rst

@@ -0,0 +1,5 @@
+cuda
+====
+
+.. doxygenfile:: platform/linux/cuda.h
+   :allow-dot-graphs:

docs/source/source_code/src/platform/linux/graphics.rst

@@ -0,0 +1,4 @@
+graphics
+========
+
+.. Todo:: Add graphics.h

docs/source/source_code/src/platform/linux/misc.rst

@@ -0,0 +1,4 @@
+misc
+====
+
+.. Todo:: Add misc.h