docs: use doxygen directly and drop breathe (#2739)
This commit is contained in:
ReenigneArcher
GitHub
parent
4683bcaf36
commit
10666c0194
50 changed files with 88 additions and 268 deletions
|
|
@ -55,37 +55,12 @@ Example Documentation Blocks
|
|||
Source
|
||||
------
|
||||
|
||||
.. toctree::
|
||||
:caption: src
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
Please refer to the `Doxygen Documentation <../doxyhtml/index.html>`_ for more details.
|
||||
|
||||
src/*
|
||||
.. todo:: Sphinx and Breathe do not support the Objective-C Domain.
|
||||
See https://github.com/breathe-doc/breathe/issues/129
|
||||
|
||||
.. toctree::
|
||||
:caption: src/platform
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
.. .. doxygenindex::
|
||||
.. :allow-dot-graphs:
|
||||
|
||||
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...
|
||||
|
|
|
|||
|
|
@ -1,5 +0,0 @@
|
|||
audio
|
||||
=====
|
||||
|
||||
.. doxygenfile:: audio.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
cbs
|
||||
===
|
||||
|
||||
.. doxygenfile:: cbs.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
config
|
||||
======
|
||||
|
||||
.. doxygenfile:: config.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
confighttp
|
||||
==========
|
||||
|
||||
.. doxygenfile:: confighttp.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
crypto
|
||||
======
|
||||
|
||||
.. doxygenfile:: crypto.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
entry_handler
|
||||
=============
|
||||
|
||||
.. doxygenfile:: entry_handler.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
file_handler
|
||||
============
|
||||
|
||||
.. doxygenfile:: file_handler.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
globals
|
||||
=======
|
||||
|
||||
.. doxygenfile:: globals.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
httpcommon
|
||||
==========
|
||||
|
||||
.. doxygenfile:: httpcommon.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
input
|
||||
=====
|
||||
|
||||
.. doxygenfile:: input.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
logging
|
||||
=======
|
||||
|
||||
.. doxygenfile:: logging.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
main
|
||||
====
|
||||
|
||||
.. doxygenfile:: main.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
move_by_copy
|
||||
============
|
||||
|
||||
.. doxygenfile:: move_by_copy.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
network
|
||||
=======
|
||||
|
||||
.. doxygenfile:: network.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
nvhttp
|
||||
======
|
||||
|
||||
.. doxygenfile:: nvhttp.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
common
|
||||
======
|
||||
|
||||
.. todo:: Add common.h
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
cuda
|
||||
====
|
||||
|
||||
.. doxygenfile:: platform/linux/cuda.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
graphics
|
||||
========
|
||||
|
||||
.. todo:: Add graphics.h
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
misc
|
||||
====
|
||||
|
||||
.. todo:: Add misc.h
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
vaapi
|
||||
=====
|
||||
|
||||
.. doxygenfile:: platform/linux/vaapi.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
wayland
|
||||
=======
|
||||
|
||||
.. doxygenfile:: platform/linux/wayland.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
x11grab
|
||||
=======
|
||||
|
||||
.. todo:: Add x11grab.h
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
av_audio
|
||||
========
|
||||
|
||||
.. todo:: Add av_audio.h
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
av_img_t
|
||||
========
|
||||
|
||||
.. todo:: Add av_img_t.h
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
av_video
|
||||
========
|
||||
|
||||
.. todo:: Add av_video.h
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
misc
|
||||
====
|
||||
|
||||
.. doxygenfile:: platform/macos/misc.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
nv12_zero_device
|
||||
================
|
||||
|
||||
.. todo:: Add nv12_zero_device.h
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
PolicyConfig
|
||||
============
|
||||
|
||||
.. todo:: Add PolicyConfig.h
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
display
|
||||
=======
|
||||
|
||||
.. todo:: Add display.h
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
misc
|
||||
====
|
||||
|
||||
.. doxygenfile:: platform/windows/misc.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
process
|
||||
=======
|
||||
|
||||
.. doxygenfile:: process.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
round_robin
|
||||
===========
|
||||
|
||||
.. doxygenfile:: round_robin.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
rtsp
|
||||
====
|
||||
|
||||
.. doxygenfile:: rtsp.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
stream
|
||||
======
|
||||
|
||||
.. doxygenfile:: stream.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
sync
|
||||
====
|
||||
|
||||
.. doxygenfile:: sync.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
system_tray
|
||||
===========
|
||||
|
||||
.. doxygenfile:: system_tray.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
task_pool
|
||||
=========
|
||||
|
||||
.. doxygenfile:: task_pool.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
thread_pool
|
||||
===========
|
||||
|
||||
.. doxygenfile:: thread_pool.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
thread_safe
|
||||
===========
|
||||
|
||||
.. doxygenfile:: thread_safe.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
upnp
|
||||
====
|
||||
|
||||
.. doxygenfile:: upnp.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
utility
|
||||
=======
|
||||
|
||||
.. todo:: Add utility.h
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
uuid
|
||||
====
|
||||
|
||||
.. doxygenfile:: uuid.h
|
||||
:allow-dot-graphs:
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
video
|
||||
=====
|
||||
|
||||
.. doxygenfile:: video.h
|
||||
:allow-dot-graphs:
|
||||
Loading…
Add table
Add a link
Reference in a new issue