mirror of
https://gitlab.freedesktop.org/pipewire/pipewire
synced 2024-10-14 20:02:38 +00:00
fd58eec7f8
Add reference documentation for configuration settings & node/device properties. We should have boring & exhaustive reference lists of all the options, and an index where they can be looked up as needed. The content is mostly stolen from the Wiki. Add pipewire-client.conf.5, pipewire-jack.conf.5, and pipewire-device.7 that try to explain all available configuration settings for native/ALSA/JACK clients, and parameters & properties devices. Expand pipewire.conf.5 and pipewire-pulse.conf.5 with lists of supported properties. Also explain environment variables. Doxygen doesn't have an indexing mechanism suitable for configuration settings, so add a simple one using an input filter and use it here. Tweak styling a bit.
77 lines
2.2 KiB
Plaintext
77 lines
2.2 KiB
Plaintext
PROJECT_NAME = PipeWire
|
|
PROJECT_NUMBER = @PACKAGE_VERSION@
|
|
OUTPUT_DIRECTORY = "@output_directory@"
|
|
FULL_PATH_NAMES = YES
|
|
JAVADOC_AUTOBRIEF = YES
|
|
TAB_SIZE = 8
|
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
|
EXTRACT_ALL = YES
|
|
EXTRACT_STATIC = YES
|
|
STRIP_FROM_PATH = @path_prefixes@
|
|
STRIP_FROM_INC_PATH = @path_prefixes@
|
|
SHOW_FILES = NO
|
|
SHOW_INCLUDE_FILES = NO
|
|
GENERATE_TODOLIST = NO
|
|
GENERATE_TESTLIST = NO
|
|
GENERATE_BUGLIST = NO
|
|
GENERATE_DEPRECATEDLIST= NO
|
|
QUIET = YES
|
|
WARN_NO_PARAMDOC = YES
|
|
HAVE_DOT = @HAVE_DOT@
|
|
INPUT = @inputs@
|
|
FILTER_PATTERNS = "*.c=@c_input_filter@" "*.h=@h_input_filter@" "*.md=@md_input_filter@"
|
|
FILE_PATTERNS = "*.h" "*.c"
|
|
RECURSIVE = YES
|
|
EXAMPLE_PATH = "@top_srcdir@/src/examples" \
|
|
"@top_srcdir@/spa/examples" \
|
|
"@top_srcdir@/doc/examples" \
|
|
"@top_srcdir@/doc/dox"
|
|
EXAMPLE_PATTERNS = "*.c" "*.inc"
|
|
|
|
GENERATE_MAN = YES
|
|
MAN_EXTENSION = 3
|
|
|
|
REFERENCED_BY_RELATION = NO
|
|
REFERENCES_RELATION = NO
|
|
IGNORE_PREFIX = pw_ \
|
|
PW_ \
|
|
spa_ \
|
|
SPA_
|
|
GENERATE_TREEVIEW = YES
|
|
SEARCHENGINE = YES
|
|
GENERATE_LATEX = NO
|
|
|
|
TOC_INCLUDE_HEADINGS = 0
|
|
LAYOUT_FILE = @layout@
|
|
|
|
MACRO_EXPANSION = YES
|
|
EXPAND_ONLY_PREDEF = YES
|
|
PREDEFINED = PA_C_DECL_BEGIN= \
|
|
PA_C_DECL_END= \
|
|
__USE_ISOC11 \
|
|
SPA_EXPORT \
|
|
SPA_PRINTF_FUNC \
|
|
SPA_DEPRECATED \
|
|
SPA_SENTINEL \
|
|
SPA_UNUSED \
|
|
SPA_NORETURN \
|
|
SPA_RESTRICT
|
|
HTML_EXTRA_STYLESHEET = @cssfiles@
|
|
|
|
MAX_INITIALIZER_LINES = 1
|
|
SORT_MEMBER_DOCS = NO
|
|
|
|
CALL_GRAPH = NO
|
|
CALLER_GRAPH = NO
|
|
CLASS_GRAPH = NO
|
|
COLLABORATION_GRAPH = NO
|
|
GROUP_GRAPHS = NO
|
|
INCLUDED_BY_GRAPH = NO
|
|
INCLUDE_GRAPH = NO
|
|
GRAPHICAL_HIERARCHY = NO
|
|
DIRECTORY_GRAPH = NO
|
|
TEMPLATE_RELATIONS = NO
|
|
|
|
# Fix up some apparent Doxygen mis-parsing
|
|
EXCLUDE_SYMBOLS = "desc" "methods" "msgid_plural" "n" "name" "props" "utils" "start"
|