OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
sof/doc/sof.doxygen.in

43 lines
1.1 KiB
Plaintext
Raw Normal View History

Makefile support for doc target. Builds uapi documentation in html format using doxygen. See doc/sof_uapi/html/index.html First dox samples in the source code provided by the patch. Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-04-13 19:03:42 +08:00
PROJECT_NAME = "Sound Open Firmware"
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-06-29 21:19:12 +08:00
OUTPUT_DIRECTORY = doxygen
Makefile support for doc target. Builds uapi documentation in html format using doxygen. See doc/sof_uapi/html/index.html First dox samples in the source code provided by the patch. Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-04-13 19:03:42 +08:00
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_XML = YES
CASE_SENSE_NAMES = NO
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 21:04:48 +08:00
INPUT = @top_srcdir@/src/include/ipc \
@top_srcdir@/src/include/kernel \
@top_srcdir@/src/include/user \
header: rtos: decouple headers into rtos specific directories. No functional runtime change, but changes to rtos partitioning and the layout of headers . This patch creates RTOS specifc header paths and updates spinlock.h and kernel.h to show the new usage. Other headers will incrementally follow. It reuses the current zephyr topleve directory and creates a new toplevel xtos directory for xtos specific files. Due to the mixing of RTOS, driver and library headers at the top level include directory it was necessary to create rtos specific header directories i.e. src/include/rtos-xtos src/include/rtos-zephyr These RTOS include directories will eventually contain RTOS specific headers whilst common logic and structures will be placed in non RTOS directories. This will also mean "#include <sof/spinlock.h>" will become "#include <rtos/spinlock.h>" and will allow easier visualisation of where and why RTOS headers are being used. This will help to eliminate cross usage of headers between RTOSes. Subsequqnt patches will move more headers and rtos specific wrppaer source files into rtos specific locations. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
2022-08-19 21:10:56 +08:00
@top_srcdir@/src/include/sof \
@top_srcdir@/xtos/include
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-07 20:49:10 +08:00
# Exlude some 3rd party codec headers with external references
EXCLUDE = @top_srcdir@/src/include/sof/audio/MaxxEffect
Makefile support for doc target. Builds uapi documentation in html format using doxygen. See doc/sof_uapi/html/index.html First dox samples in the source code provided by the patch. Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-04-13 19:03:42 +08:00
RECURSIVE = YES
FILE_PATTERNS = *.c *.h
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-26 09:11:13 +08:00
EXAMPLE_PATH = @top_srcdir@/test
Makefile support for doc target. Builds uapi documentation in html format using doxygen. See doc/sof_uapi/html/index.html First dox samples in the source code provided by the patch. Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-04-13 19:03:42 +08:00
IMAGE_PATH =
QUIET = YES
dox: reformatted documentation for component and ipc control Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2019-02-04 19:03:59 +08:00
EXTRACT_ALL = YES
EXTRACT_STATIC = YES
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 17:06:31 +08:00
WARN_IF_UNDOCUMENTED = NO
Makefile support for doc target. Builds uapi documentation in html format using doxygen. See doc/sof_uapi/html/index.html First dox samples in the source code provided by the patch. Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-04-13 19:03:42 +08:00
SHOW_INCLUDE_FILES = NO
dox: reformatted documentation for component and ipc control Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2019-02-04 19:03:59 +08:00
JAVADOC_AUTOBRIEF = YES
Makefile support for doc target. Builds uapi documentation in html format using doxygen. See doc/sof_uapi/html/index.html First dox samples in the source code provided by the patch. Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-04-13 19:03:42 +08:00
INHERIT_DOCS = YES
ENABLED_SECTIONS = ""
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
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-26 03:15:50 +08:00
PREDEFINED = "__attribute__(x)= " \
"CONFIG_FORMAT_S16LE=1" \
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-20 14:40:35 +08:00
"CONFIG_FORMAT_S32LE=1" \
"CONFIG_TRACE=1"
Makefile support for doc target. Builds uapi documentation in html format using doxygen. See doc/sof_uapi/html/index.html First dox samples in the source code provided by the patch. Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
2018-04-13 19:03:42 +08:00
OPTIMIZE_OUTPUT_FOR_C = YES
TYPEDEF_HIDES_STRUCT = YES
#INPUT_FILTER = inputfilter
#FILTER_SOURCE_FILES = YES
HTML_TIMESTAMP = NO