docs: use glob pattern to match source code docs (#1918)
This commit is contained in:
@@ -1,10 +0,0 @@
|
|||||||
platform
|
|
||||||
========
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
platform/common
|
|
||||||
platform/linux
|
|
||||||
platform/macos
|
|
||||||
platform/windows
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
linux
|
|
||||||
=====
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
linux/cuda
|
|
||||||
linux/graphics
|
|
||||||
linux/misc
|
|
||||||
linux/vaapi
|
|
||||||
linux/wayland
|
|
||||||
linux/x11grab
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
macos
|
|
||||||
=====
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
macos/av_audio
|
|
||||||
macos/av_img_t
|
|
||||||
macos/av_video
|
|
||||||
macos/misc
|
|
||||||
macos/nv12_zero_device
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
windows
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
windows/display
|
|
||||||
windows/misc
|
|
||||||
windows/PolicyConfig
|
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
src
|
Source Code
|
||||||
===
|
===========
|
||||||
We are in process of improving the source code documentation. Code should be documented using Doxygen syntax.
|
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
|
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
|
rendered docs, the definition of the object must be in a header file, although the documentation itself can (and
|
||||||
@@ -52,35 +52,40 @@ Example Documentation Blocks
|
|||||||
// do stuff
|
// do stuff
|
||||||
}
|
}
|
||||||
|
|
||||||
Code
|
Source
|
||||||
----
|
------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
|
||||||
:caption: src
|
:caption: src
|
||||||
|
:maxdepth: 1
|
||||||
|
:glob:
|
||||||
|
|
||||||
src/main
|
src/*
|
||||||
src/audio
|
|
||||||
src/cbs
|
.. toctree::
|
||||||
src/config
|
:caption: src/platform
|
||||||
src/confighttp
|
:maxdepth: 1
|
||||||
src/crypto
|
:glob:
|
||||||
src/httpcommon
|
|
||||||
src/input
|
src/platform/*
|
||||||
src/move_by_copy
|
|
||||||
src/network
|
.. toctree::
|
||||||
src/nvhttp
|
:caption: src/platform/linux
|
||||||
src/process
|
:maxdepth: 1
|
||||||
src/round_robin
|
:glob:
|
||||||
src/rtsp
|
|
||||||
src/stream
|
src/platform/linux/*
|
||||||
src/sync
|
|
||||||
src/system_tray
|
.. toctree::
|
||||||
src/task_pool
|
:caption: src/platform/macos
|
||||||
src/thread_pool
|
:maxdepth: 1
|
||||||
src/thread_safe
|
:glob:
|
||||||
src/upnp
|
|
||||||
src/utility
|
src/platform/macos/*
|
||||||
src/uuid
|
|
||||||
src/video
|
.. toctree::
|
||||||
src/platform
|
:caption: src/platform/windows
|
||||||
|
:maxdepth: 1
|
||||||
|
:glob:
|
||||||
|
|
||||||
|
src/platform/windows/*
|
||||||
@@ -53,4 +53,4 @@
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: source
|
:caption: source
|
||||||
|
|
||||||
source/src
|
source_code/source_code
|
||||||
|
|||||||
Reference in New Issue
Block a user