doc: add the various markdown prose docs to the doxygen output

Note that the order of the includes matters - that's how doxygen will sort
them. There is no specific structure other than the include order - one reason
why the headers are being changed. Without polluting the markdown files with
doxygen commands we cannot use \subpage, so all files convert to a regular
\page and are listed as flat hierarchy in the sidebar (and in Related Pages).

Changing the headers at least provides some visual grouping with comon
prefixes.
This commit is contained in:
Peter Hutterer 2021-05-07 09:09:45 +10:00
parent d10381dfc3
commit ac05f6bb03
14 changed files with 50 additions and 19 deletions

View file

@ -1,3 +1,5 @@
# SPA Buffers
> What is the array of `spa_data` in `spa_buffer`?
A buffer contains metadata and data. There can be many metadata items (headers, color info, cursor position, etc) in the buffer. The metadata items are stored in the metas array. In the same way, the buffer can contain multiple data blocks in the datas array. Each data block is, for example, a video plane or an audio channel. There are `n_datas` of those blocks.