From 97916b7a87e7ca2b2096b3e75f0d0c6ec2c5f917 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Tue, 18 Jun 2024 21:40:40 -0400 Subject: [PATCH] docs: use doxygenindex directive for src --- docs/Doxyfile | 3 +- docs/source/source_code/source_code.rst | 36 ++----------------- docs/source/source_code/src/audio.rst | 5 --- docs/source/source_code/src/cbs.rst | 5 --- docs/source/source_code/src/config.rst | 5 --- docs/source/source_code/src/confighttp.rst | 5 --- docs/source/source_code/src/crypto.rst | 5 --- docs/source/source_code/src/entry_handler.rst | 5 --- docs/source/source_code/src/file_handler.rst | 5 --- docs/source/source_code/src/globals.rst | 5 --- docs/source/source_code/src/httpcommon.rst | 5 --- docs/source/source_code/src/input.rst | 5 --- docs/source/source_code/src/logging.rst | 5 --- docs/source/source_code/src/main.rst | 5 --- docs/source/source_code/src/move_by_copy.rst | 5 --- docs/source/source_code/src/network.rst | 5 --- docs/source/source_code/src/nvhttp.rst | 5 --- .../source_code/src/platform/common.rst | 4 --- .../source_code/src/platform/linux/cuda.rst | 5 --- .../src/platform/linux/graphics.rst | 4 --- .../source_code/src/platform/linux/misc.rst | 4 --- .../source_code/src/platform/linux/vaapi.rst | 5 --- .../src/platform/linux/wayland.rst | 5 --- .../src/platform/linux/x11grab.rst | 4 --- .../src/platform/macos/av_audio.rst | 4 --- .../src/platform/macos/av_img_t.rst | 4 --- .../src/platform/macos/av_video.rst | 4 --- .../source_code/src/platform/macos/misc.rst | 5 --- .../src/platform/macos/nv12_zero_device.rst | 4 --- .../src/platform/windows/PolicyConfig.rst | 4 --- .../src/platform/windows/display.rst | 4 --- .../source_code/src/platform/windows/misc.rst | 5 --- docs/source/source_code/src/process.rst | 5 --- docs/source/source_code/src/round_robin.rst | 5 --- docs/source/source_code/src/rtsp.rst | 5 --- docs/source/source_code/src/stream.rst | 5 --- docs/source/source_code/src/sync.rst | 5 --- docs/source/source_code/src/system_tray.rst | 5 --- docs/source/source_code/src/task_pool.rst | 5 --- docs/source/source_code/src/thread_pool.rst | 5 --- docs/source/source_code/src/thread_safe.rst | 5 --- docs/source/source_code/src/upnp.rst | 5 --- docs/source/source_code/src/utility.rst | 4 --- docs/source/source_code/src/uuid.rst | 5 --- docs/source/source_code/src/video.rst | 5 --- 45 files changed, 5 insertions(+), 238 deletions(-) delete mode 100644 docs/source/source_code/src/audio.rst delete mode 100644 docs/source/source_code/src/cbs.rst delete mode 100644 docs/source/source_code/src/config.rst delete mode 100644 docs/source/source_code/src/confighttp.rst delete mode 100644 docs/source/source_code/src/crypto.rst delete mode 100644 docs/source/source_code/src/entry_handler.rst delete mode 100644 docs/source/source_code/src/file_handler.rst delete mode 100644 docs/source/source_code/src/globals.rst delete mode 100644 docs/source/source_code/src/httpcommon.rst delete mode 100644 docs/source/source_code/src/input.rst delete mode 100644 docs/source/source_code/src/logging.rst delete mode 100644 docs/source/source_code/src/main.rst delete mode 100644 docs/source/source_code/src/move_by_copy.rst delete mode 100644 docs/source/source_code/src/network.rst delete mode 100644 docs/source/source_code/src/nvhttp.rst delete mode 100644 docs/source/source_code/src/platform/common.rst delete mode 100644 docs/source/source_code/src/platform/linux/cuda.rst delete mode 100644 docs/source/source_code/src/platform/linux/graphics.rst delete mode 100644 docs/source/source_code/src/platform/linux/misc.rst delete mode 100644 docs/source/source_code/src/platform/linux/vaapi.rst delete mode 100644 docs/source/source_code/src/platform/linux/wayland.rst delete mode 100644 docs/source/source_code/src/platform/linux/x11grab.rst delete mode 100644 docs/source/source_code/src/platform/macos/av_audio.rst delete mode 100644 docs/source/source_code/src/platform/macos/av_img_t.rst delete mode 100644 docs/source/source_code/src/platform/macos/av_video.rst delete mode 100644 docs/source/source_code/src/platform/macos/misc.rst delete mode 100644 docs/source/source_code/src/platform/macos/nv12_zero_device.rst delete mode 100644 docs/source/source_code/src/platform/windows/PolicyConfig.rst delete mode 100644 docs/source/source_code/src/platform/windows/display.rst delete mode 100644 docs/source/source_code/src/platform/windows/misc.rst delete mode 100644 docs/source/source_code/src/process.rst delete mode 100644 docs/source/source_code/src/round_robin.rst delete mode 100644 docs/source/source_code/src/rtsp.rst delete mode 100644 docs/source/source_code/src/stream.rst delete mode 100644 docs/source/source_code/src/sync.rst delete mode 100644 docs/source/source_code/src/system_tray.rst delete mode 100644 docs/source/source_code/src/task_pool.rst delete mode 100644 docs/source/source_code/src/thread_pool.rst delete mode 100644 docs/source/source_code/src/thread_safe.rst delete mode 100644 docs/source/source_code/src/upnp.rst delete mode 100644 docs/source/source_code/src/utility.rst delete mode 100644 docs/source/source_code/src/uuid.rst delete mode 100644 docs/source/source_code/src/video.rst diff --git a/docs/Doxyfile b/docs/Doxyfile index df647b71d9d..ed00410ad7d 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -2456,7 +2456,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = DOXYGEN +PREDEFINED = DOXYGEN \ + STDMETHODCALLTYPE= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/docs/source/source_code/source_code.rst b/docs/source/source_code/source_code.rst index fecc6801c92..bfd6a8638bd 100644 --- a/docs/source/source_code/source_code.rst +++ b/docs/source/source_code/source_code.rst @@ -55,37 +55,7 @@ Example Documentation Blocks Source ------ -.. toctree:: - :caption: src - :maxdepth: 1 - :glob: +.. doxygenindex:: + :allow-dot-graphs: - 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/* +.. Ideally, we would use `doxygenfile` with `:allow-dot-graphs:`, but sphinx complains about duplicated namespaces... diff --git a/docs/source/source_code/src/audio.rst b/docs/source/source_code/src/audio.rst deleted file mode 100644 index 08665fe6780..00000000000 --- a/docs/source/source_code/src/audio.rst +++ /dev/null @@ -1,5 +0,0 @@ -audio -===== - -.. doxygenfile:: audio.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/cbs.rst b/docs/source/source_code/src/cbs.rst deleted file mode 100644 index 6547c495821..00000000000 --- a/docs/source/source_code/src/cbs.rst +++ /dev/null @@ -1,5 +0,0 @@ -cbs -=== - -.. doxygenfile:: cbs.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/config.rst b/docs/source/source_code/src/config.rst deleted file mode 100644 index 34bccff3ce2..00000000000 --- a/docs/source/source_code/src/config.rst +++ /dev/null @@ -1,5 +0,0 @@ -config -====== - -.. doxygenfile:: config.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/confighttp.rst b/docs/source/source_code/src/confighttp.rst deleted file mode 100644 index 348f6521ba6..00000000000 --- a/docs/source/source_code/src/confighttp.rst +++ /dev/null @@ -1,5 +0,0 @@ -confighttp -========== - -.. doxygenfile:: confighttp.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/crypto.rst b/docs/source/source_code/src/crypto.rst deleted file mode 100644 index aced9d35c68..00000000000 --- a/docs/source/source_code/src/crypto.rst +++ /dev/null @@ -1,5 +0,0 @@ -crypto -====== - -.. doxygenfile:: crypto.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/entry_handler.rst b/docs/source/source_code/src/entry_handler.rst deleted file mode 100644 index c522b065652..00000000000 --- a/docs/source/source_code/src/entry_handler.rst +++ /dev/null @@ -1,5 +0,0 @@ -entry_handler -============= - -.. doxygenfile:: entry_handler.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/file_handler.rst b/docs/source/source_code/src/file_handler.rst deleted file mode 100644 index 221b8cbde03..00000000000 --- a/docs/source/source_code/src/file_handler.rst +++ /dev/null @@ -1,5 +0,0 @@ -file_handler -============ - -.. doxygenfile:: file_handler.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/globals.rst b/docs/source/source_code/src/globals.rst deleted file mode 100644 index ed70cecf692..00000000000 --- a/docs/source/source_code/src/globals.rst +++ /dev/null @@ -1,5 +0,0 @@ -globals -======= - -.. doxygenfile:: globals.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/httpcommon.rst b/docs/source/source_code/src/httpcommon.rst deleted file mode 100644 index 67557f86860..00000000000 --- a/docs/source/source_code/src/httpcommon.rst +++ /dev/null @@ -1,5 +0,0 @@ -httpcommon -========== - -.. doxygenfile:: httpcommon.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/input.rst b/docs/source/source_code/src/input.rst deleted file mode 100644 index 4c8db082dc6..00000000000 --- a/docs/source/source_code/src/input.rst +++ /dev/null @@ -1,5 +0,0 @@ -input -===== - -.. doxygenfile:: input.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/logging.rst b/docs/source/source_code/src/logging.rst deleted file mode 100644 index 6b037c20e46..00000000000 --- a/docs/source/source_code/src/logging.rst +++ /dev/null @@ -1,5 +0,0 @@ -logging -======= - -.. doxygenfile:: logging.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/main.rst b/docs/source/source_code/src/main.rst deleted file mode 100644 index 5102a3e9448..00000000000 --- a/docs/source/source_code/src/main.rst +++ /dev/null @@ -1,5 +0,0 @@ -main -==== - -.. doxygenfile:: main.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/move_by_copy.rst b/docs/source/source_code/src/move_by_copy.rst deleted file mode 100644 index 5ec37716a9a..00000000000 --- a/docs/source/source_code/src/move_by_copy.rst +++ /dev/null @@ -1,5 +0,0 @@ -move_by_copy -============ - -.. doxygenfile:: move_by_copy.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/network.rst b/docs/source/source_code/src/network.rst deleted file mode 100644 index a9121e16008..00000000000 --- a/docs/source/source_code/src/network.rst +++ /dev/null @@ -1,5 +0,0 @@ -network -======= - -.. doxygenfile:: network.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/nvhttp.rst b/docs/source/source_code/src/nvhttp.rst deleted file mode 100644 index 8a3bbd008a5..00000000000 --- a/docs/source/source_code/src/nvhttp.rst +++ /dev/null @@ -1,5 +0,0 @@ -nvhttp -====== - -.. doxygenfile:: nvhttp.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/platform/common.rst b/docs/source/source_code/src/platform/common.rst deleted file mode 100644 index ec0ca47a9b6..00000000000 --- a/docs/source/source_code/src/platform/common.rst +++ /dev/null @@ -1,4 +0,0 @@ -common -====== - -.. todo:: Add common.h diff --git a/docs/source/source_code/src/platform/linux/cuda.rst b/docs/source/source_code/src/platform/linux/cuda.rst deleted file mode 100644 index 5b6dffe770b..00000000000 --- a/docs/source/source_code/src/platform/linux/cuda.rst +++ /dev/null @@ -1,5 +0,0 @@ -cuda -==== - -.. doxygenfile:: platform/linux/cuda.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/platform/linux/graphics.rst b/docs/source/source_code/src/platform/linux/graphics.rst deleted file mode 100644 index 2f44e10986e..00000000000 --- a/docs/source/source_code/src/platform/linux/graphics.rst +++ /dev/null @@ -1,4 +0,0 @@ -graphics -======== - -.. todo:: Add graphics.h diff --git a/docs/source/source_code/src/platform/linux/misc.rst b/docs/source/source_code/src/platform/linux/misc.rst deleted file mode 100644 index 2e30a58eda1..00000000000 --- a/docs/source/source_code/src/platform/linux/misc.rst +++ /dev/null @@ -1,4 +0,0 @@ -misc -==== - -.. todo:: Add misc.h diff --git a/docs/source/source_code/src/platform/linux/vaapi.rst b/docs/source/source_code/src/platform/linux/vaapi.rst deleted file mode 100644 index 973e78523b4..00000000000 --- a/docs/source/source_code/src/platform/linux/vaapi.rst +++ /dev/null @@ -1,5 +0,0 @@ -vaapi -===== - -.. doxygenfile:: platform/linux/vaapi.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/platform/linux/wayland.rst b/docs/source/source_code/src/platform/linux/wayland.rst deleted file mode 100644 index 670e4340ab0..00000000000 --- a/docs/source/source_code/src/platform/linux/wayland.rst +++ /dev/null @@ -1,5 +0,0 @@ -wayland -======= - -.. doxygenfile:: platform/linux/wayland.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/platform/linux/x11grab.rst b/docs/source/source_code/src/platform/linux/x11grab.rst deleted file mode 100644 index c0c2f7cccce..00000000000 --- a/docs/source/source_code/src/platform/linux/x11grab.rst +++ /dev/null @@ -1,4 +0,0 @@ -x11grab -======= - -.. todo:: Add x11grab.h diff --git a/docs/source/source_code/src/platform/macos/av_audio.rst b/docs/source/source_code/src/platform/macos/av_audio.rst deleted file mode 100644 index 92f04868e19..00000000000 --- a/docs/source/source_code/src/platform/macos/av_audio.rst +++ /dev/null @@ -1,4 +0,0 @@ -av_audio -======== - -.. todo:: Add av_audio.h diff --git a/docs/source/source_code/src/platform/macos/av_img_t.rst b/docs/source/source_code/src/platform/macos/av_img_t.rst deleted file mode 100644 index 4fa8510ddea..00000000000 --- a/docs/source/source_code/src/platform/macos/av_img_t.rst +++ /dev/null @@ -1,4 +0,0 @@ -av_img_t -======== - -.. todo:: Add av_img_t.h diff --git a/docs/source/source_code/src/platform/macos/av_video.rst b/docs/source/source_code/src/platform/macos/av_video.rst deleted file mode 100644 index 179b180b8b9..00000000000 --- a/docs/source/source_code/src/platform/macos/av_video.rst +++ /dev/null @@ -1,4 +0,0 @@ -av_video -======== - -.. todo:: Add av_video.h diff --git a/docs/source/source_code/src/platform/macos/misc.rst b/docs/source/source_code/src/platform/macos/misc.rst deleted file mode 100644 index 26cbc1874c6..00000000000 --- a/docs/source/source_code/src/platform/macos/misc.rst +++ /dev/null @@ -1,5 +0,0 @@ -misc -==== - -.. doxygenfile:: platform/macos/misc.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/platform/macos/nv12_zero_device.rst b/docs/source/source_code/src/platform/macos/nv12_zero_device.rst deleted file mode 100644 index 8e236a5125e..00000000000 --- a/docs/source/source_code/src/platform/macos/nv12_zero_device.rst +++ /dev/null @@ -1,4 +0,0 @@ -nv12_zero_device -================ - -.. todo:: Add nv12_zero_device.h diff --git a/docs/source/source_code/src/platform/windows/PolicyConfig.rst b/docs/source/source_code/src/platform/windows/PolicyConfig.rst deleted file mode 100644 index a47e89ac4b0..00000000000 --- a/docs/source/source_code/src/platform/windows/PolicyConfig.rst +++ /dev/null @@ -1,4 +0,0 @@ -PolicyConfig -============ - -.. todo:: Add PolicyConfig.h diff --git a/docs/source/source_code/src/platform/windows/display.rst b/docs/source/source_code/src/platform/windows/display.rst deleted file mode 100644 index 033e22e29fa..00000000000 --- a/docs/source/source_code/src/platform/windows/display.rst +++ /dev/null @@ -1,4 +0,0 @@ -display -======= - -.. todo:: Add display.h diff --git a/docs/source/source_code/src/platform/windows/misc.rst b/docs/source/source_code/src/platform/windows/misc.rst deleted file mode 100644 index 88c1620002a..00000000000 --- a/docs/source/source_code/src/platform/windows/misc.rst +++ /dev/null @@ -1,5 +0,0 @@ -misc -==== - -.. doxygenfile:: platform/windows/misc.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/process.rst b/docs/source/source_code/src/process.rst deleted file mode 100644 index ad8f9764114..00000000000 --- a/docs/source/source_code/src/process.rst +++ /dev/null @@ -1,5 +0,0 @@ -process -======= - -.. doxygenfile:: process.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/round_robin.rst b/docs/source/source_code/src/round_robin.rst deleted file mode 100644 index 89aea6f5904..00000000000 --- a/docs/source/source_code/src/round_robin.rst +++ /dev/null @@ -1,5 +0,0 @@ -round_robin -=========== - -.. doxygenfile:: round_robin.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/rtsp.rst b/docs/source/source_code/src/rtsp.rst deleted file mode 100644 index 7aee0baf056..00000000000 --- a/docs/source/source_code/src/rtsp.rst +++ /dev/null @@ -1,5 +0,0 @@ -rtsp -==== - -.. doxygenfile:: rtsp.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/stream.rst b/docs/source/source_code/src/stream.rst deleted file mode 100644 index c771414016a..00000000000 --- a/docs/source/source_code/src/stream.rst +++ /dev/null @@ -1,5 +0,0 @@ -stream -====== - -.. doxygenfile:: stream.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/sync.rst b/docs/source/source_code/src/sync.rst deleted file mode 100644 index 6f3d95929e2..00000000000 --- a/docs/source/source_code/src/sync.rst +++ /dev/null @@ -1,5 +0,0 @@ -sync -==== - -.. doxygenfile:: sync.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/system_tray.rst b/docs/source/source_code/src/system_tray.rst deleted file mode 100644 index 7c1009e1c8c..00000000000 --- a/docs/source/source_code/src/system_tray.rst +++ /dev/null @@ -1,5 +0,0 @@ -system_tray -=========== - -.. doxygenfile:: system_tray.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/task_pool.rst b/docs/source/source_code/src/task_pool.rst deleted file mode 100644 index a556141aa4c..00000000000 --- a/docs/source/source_code/src/task_pool.rst +++ /dev/null @@ -1,5 +0,0 @@ -task_pool -========= - -.. doxygenfile:: task_pool.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/thread_pool.rst b/docs/source/source_code/src/thread_pool.rst deleted file mode 100644 index 32787512811..00000000000 --- a/docs/source/source_code/src/thread_pool.rst +++ /dev/null @@ -1,5 +0,0 @@ -thread_pool -=========== - -.. doxygenfile:: thread_pool.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/thread_safe.rst b/docs/source/source_code/src/thread_safe.rst deleted file mode 100644 index d7ecdda3f43..00000000000 --- a/docs/source/source_code/src/thread_safe.rst +++ /dev/null @@ -1,5 +0,0 @@ -thread_safe -=========== - -.. doxygenfile:: thread_safe.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/upnp.rst b/docs/source/source_code/src/upnp.rst deleted file mode 100644 index 987692353b7..00000000000 --- a/docs/source/source_code/src/upnp.rst +++ /dev/null @@ -1,5 +0,0 @@ -upnp -==== - -.. doxygenfile:: upnp.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/utility.rst b/docs/source/source_code/src/utility.rst deleted file mode 100644 index 80ffd14ad5a..00000000000 --- a/docs/source/source_code/src/utility.rst +++ /dev/null @@ -1,4 +0,0 @@ -utility -======= - -.. todo:: Add utility.h diff --git a/docs/source/source_code/src/uuid.rst b/docs/source/source_code/src/uuid.rst deleted file mode 100644 index d21e0a6ceaf..00000000000 --- a/docs/source/source_code/src/uuid.rst +++ /dev/null @@ -1,5 +0,0 @@ -uuid -==== - -.. doxygenfile:: uuid.h - :allow-dot-graphs: diff --git a/docs/source/source_code/src/video.rst b/docs/source/source_code/src/video.rst deleted file mode 100644 index 2e45883f293..00000000000 --- a/docs/source/source_code/src/video.rst +++ /dev/null @@ -1,5 +0,0 @@ -video -===== - -.. doxygenfile:: video.h - :allow-dot-graphs: