Commit Graph

8 Commits

Author SHA1 Message Date
Marc Herbert 3f4da1f1bb sof.doxygen.in: add CONFIG_TRACE=1
Stop ignoring most comments in the trace.h file.

Confusingly, only comments in trace.c were considered because unlike
trace.h, trace.c is not turned off by the preprocessor but by CMake
instead.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2021-07-21 09:17:05 +01:00
Liam R Girdwood fa639cf307 doxygen: codecs: exclude 3rd party codec headers from Doxygen
Lets try and keep 3rd party codec headers as-is without any modifications.
This include doxygen as some references may be in closed headers.

Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
2021-04-10 21:53:32 +01:00
Marc Herbert e163bf1513 sof.doxygen.in: change ../test to @top_srcdir@/test
Makes it possible to place the build directory anywhere.

This directory does not seem in use any more; fixing it does not change
the doxygen output. However this does silence a doxygen error message
when the build directory is not in the usual place.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2021-01-27 11:00:04 +00:00
Marcin Maka eee6a252a5 audio-stream: dox: add full api documentation
Audio stream is an important piece used by components
therefore full documentation is required by component
developers to operate on source and sink buffers
attached ot their components.

Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2020-03-28 13:04:55 +01:00
Janusz Jankowski e39ed5ebf4 include: split uapi headers into more directories
Some of interface headers are not needed by kernel,
but are needed by user-space applications, so we can split them
into multiple directories that indicate their purpose.

Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-05-31 20:10:45 +01:00
Marcin Maka 8169a9ec07 dox: reformatted documentation for component and ipc control
Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2019-02-04 12:42:03 +00:00
Marcin Maka 2fa1119c7a doc: doxygen and breathe warnings neutralized
- There is too much undocumented code, so warn about syntax errors
  in the existing dox only.
- Breathe does not understand __attribute__, so preproc this out.

Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-07-03 11:23:53 +02:00
Marcin Maka 88c12a1f52 doc: renamed doxygen output dir to doxygen
Integration with sof-docs and breathe does not require
to split the output. So write to a single one and refer
later by doxygen groups.

Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-07-03 11:23:52 +02:00