mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/doc/Doxyfile.in

44 lines
1.2 KiB
Text
Raw Normal View History

Add doxygen docs
2017-05-30 19:46:51 +02:00
PROJECT_NAME = PipeWire
PROJECT_NUMBER = @PACKAGE_VERSION@
OUTPUT_DIRECTORY = doc
FULL_PATH_NAMES = NO
JAVADOC_AUTOBRIEF = YES
TAB_SIZE = 8
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_ALL = YES
SHOW_INCLUDE_FILES = NO
GENERATE_TODOLIST = NO
GENERATE_TESTLIST = NO
GENERATE_BUGLIST = NO
QUIET = YES
WARN_NO_PARAMDOC = YES
doc: define HAVE_DOT to generate dot files Fixes #1585
2021-09-09 13:00:44 +02:00
HAVE_DOT = @HAVE_DOT@
update docs
2017-09-05 13:35:25 +02:00
INPUT = @inputs@
Add doxygen docs
2017-05-30 19:46:51 +02:00
FILE_PATTERNS = "*.h" "*.c"
doc: add spa to doxygen output This requires a helper script: doxygen doesn't differ between static methods and static inline methods. EXTRACT_STATIC defines whether it parses *any* static method but we're currently using all C files as input files as well. We cannot convince doxygen to just parse static inline functions in header files so for SPA we hack around this: meson passes the spa headers to a shell script with simply copies those changed to `/* static */ inline void (foo)` and doxygen then runs on those header files. The result: we get all spa functions added to your doxygen output at the cost of a few sed calls.
2021-05-21 13:53:19 +10:00
RECURSIVE = YES
move things around
2017-07-11 15:57:20 +02:00
EXAMPLE_PATH = "@top_srcdir@/src/tools" \
"@top_srcdir@/src/examples"
Add doxygen docs
2017-05-30 19:46:51 +02:00
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
IGNORE_PREFIX = pw_ \
PW_
doc: reduce the Doxyfile to only non-default options This provides a much easier overview of what the actual changes are to doxygen's default values.
2021-05-07 08:44:59 +10:00
GENERATE_TREEVIEW = YES
SEARCHENGINE = NO
GENERATE_LATEX = NO
Add doxygen docs
2017-05-30 19:46:51 +02:00
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = PA_C_DECL_BEGIN= \
doc: define __USE_ISOC11 for doxygen to pick up the logger #defines This way doxygen will pick up the #defines for spa_log_error, etc. Without this define it uses the else part of the condition which uses macros to construct function names.
2021-06-24 10:48:04 +10:00
PA_C_DECL_END= \
doc: ignore SPA_EXPORT and SPA_PRINTF_FUNC This caused doxygen to include a rather random assortment of variables and link to them from various pages (e.g. "arg", "res", "buffer", NAME, etc.)
2021-08-04 17:04:52 +10:00
__USE_ISOC11 \
SPA_EXPORT \
doc: ignore all function attributes in doxygen
2021-08-05 16:53:21 +10:00
SPA_PRINTF_FUNC \
SPA_DEPRECATED \
SPA_SENTINEL \
SPA_UNUSED \
SPA_NORETURN \
SPA_RESTRICT
doc: add a custom doxygen theme based on doxygen-awesome Theme from doxygen-awesome-css with custom modifications based on the pipewire.org website to use the same type of blue, grey, etc. doxygen-awesome-css is MIT licensed, see https://github.com/jothepro/doxygen-awesome-css
2021-05-21 14:53:48 +10:00
HTML_EXTRA_STYLESHEET = @cssfiles@
Reference in a new issue Copy permalink