LADI
/
pipewire
1
Fork 0
Code Actions
pipewire/doc/Doxyfile.in

77 lines
2.2 KiB
Plaintext
Raw Permalink Normal View History

Add doxygen docs
2017-05-30 20:46:51 +03:00
PROJECT_NAME = PipeWire
PROJECT_NUMBER = @PACKAGE_VERSION@
doc: specify Doxygen OUTPUT_DIRECTORY as an absolute path Currently, doxygen is run by ninja in the top-level build directory, therefore the "doc" folder is always created there. However, when pipewire is built as a subproject, it should not touch the top-level build directory because it can cause conflicts and because the documentation won't be created where meson thinks it will be, so the "doxygen" target will always be dirty and installation will fail.
2023-01-14 23:02:13 +02:00
OUTPUT_DIRECTORY = "@output_directory@"
doc: hide useless indices in doxygen output etc. fixes Hide useless paginated indices. Rename "Related Pages" -> "Pages". Fix manpage brief description. Fix file path name stripping. Move macro listings after enums, so that they're next to functions. Remove pwtest from docs, it's not API. Fixup header styles.
2023-11-04 12:35:30 +02:00
FULL_PATH_NAMES = YES
Add doxygen docs
2017-05-30 20:46:51 +03:00
JAVADOC_AUTOBRIEF = YES
TAB_SIZE = 8
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_ALL = YES
doc: make Doxygen to show only symbols defined in headers Make Doxygen data structure etc. lists less cluttered by hiding non-public stuff. Add a Doxygen input filter that marks symbols declared in C files private, so that they won't appear in the output unless the symbol is also declared in a header. The "spa static inline" hack is then also not needed any more.
2021-10-02 19:24:17 +03:00
EXTRACT_STATIC = YES
STRIP_FROM_PATH = @path_prefixes@
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
STRIP_FROM_INC_PATH = @path_prefixes@
doc: don't generate Doxygen file list The file list duplicates the Module structure, and is just confusing since it also contains the .c files.
2021-10-03 23:30:23 +03:00
SHOW_FILES = NO
Add doxygen docs
2017-05-30 20:46:51 +03:00
SHOW_INCLUDE_FILES = NO
GENERATE_TODOLIST = NO
GENERATE_TESTLIST = NO
GENERATE_BUGLIST = NO
doc: disable deprecated list
2024-01-28 13:09:28 +02:00
GENERATE_DEPRECATEDLIST= NO
Add doxygen docs
2017-05-30 20:46:51 +03:00
QUIET = YES
WARN_NO_PARAMDOC = YES
doc: define HAVE_DOT to generate dot files Fixes #1585
2021-09-09 14:00:44 +03:00
HAVE_DOT = @HAVE_DOT@
update docs
2017-09-05 14:35:25 +03:00
INPUT = @inputs@
doc: add reference docs + index for config and env variables 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.
2023-12-09 18:34:56 +02:00
FILTER_PATTERNS = "*.c=@c_input_filter@" "*.h=@h_input_filter@" "*.md=@md_input_filter@"
Add doxygen docs
2017-05-30 20:46:51 +03: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 06:53:19 +03:00
RECURSIVE = YES
doc: link examples to Doxygen docs Include examples to the documentation, using Doxygen's example system.
2021-10-09 23:25:29 +03:00
EXAMPLE_PATH = "@top_srcdir@/src/examples" \
doc: add tutorials as Doxygen examples
2021-10-10 00:09:32 +03:00
"@top_srcdir@/spa/examples" \
doc: include pipewire-pulse modules explanations also on man page
2023-12-09 16:31:11 +02:00
"@top_srcdir@/doc/examples" \
"@top_srcdir@/doc/dox"
EXAMPLE_PATTERNS = "*.c" "*.inc"
Add doxygen docs
2017-05-30 20:46:51 +03:00
doc: make all manpages with Doxygen Use (fixed-up) Doxygen manpage output for all program & module manpages. This also allows formatting the manual pages properly in the HTML docs. The Markdown pages work properly only with Doxygen >= 1.9.7, older versions put them to wrong place in the HTML docs.
2023-11-21 21:31:16 +02:00
GENERATE_MAN = YES
MAN_EXTENSION = 3
doc: hide various Doxygen generated dot graphs The Doxygen autogenerated graphs are very useful and take up lots of space being on the top, so disable them. Also disable references/referenced by relations, which add clutter. Also hide most macro values.
2021-10-03 15:08:40 +03:00
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
Add doxygen docs
2017-05-30 20:46:51 +03:00
IGNORE_PREFIX = pw_ \
doc: make Doxygen to show only symbols defined in headers Make Doxygen data structure etc. lists less cluttered by hiding non-public stuff. Add a Doxygen input filter that marks symbols declared in C files private, so that they won't appear in the output unless the symbol is also declared in a header. The "spa static inline" hack is then also not needed any more.
2021-10-02 19:24:17 +03:00
PW_ \
spa_ \
SPA_
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 01:44:59 +03:00
GENERATE_TREEVIEW = YES
Doxygen - enable client side search engine.
2022-05-16 18:33:27 +03:00
SEARCHENGINE = YES
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 01:44:59 +03:00
GENERATE_LATEX = NO
Add doxygen docs
2017-05-30 20:46:51 +03:00
doc: fixup some Doxygen autogen issues Don't show page sections in left sidebar, it's confusing. Rename Modules -> API Reference in sidebar. Indicate visually the sidebar entries are collapsible. Fix spa_pod_json grouping. Move tools page to top level. Fix page ordering.
2023-11-04 11:26:27 +02:00
TOC_INCLUDE_HEADINGS = 0
LAYOUT_FILE = @layout@
Add doxygen docs
2017-05-30 20:46:51 +03: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 03:48:04 +03: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 10:04:52 +03:00
__USE_ISOC11 \
SPA_EXPORT \
doc: ignore all function attributes in doxygen
2021-08-05 09:53:21 +03: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 07:53:48 +03:00
HTML_EXTRA_STYLESHEET = @cssfiles@
doc: ignore symbols due to Doxygen mis-parsing Ignore some symbols appearing as "Variables", which seem to be due to some mis-parsing.
2021-10-02 20:19:34 +03:00
doc: hide various Doxygen generated dot graphs The Doxygen autogenerated graphs are very useful and take up lots of space being on the top, so disable them. Also disable references/referenced by relations, which add clutter. Also hide most macro values.
2021-10-03 15:08:40 +03:00
MAX_INITIALIZER_LINES = 1
doc: further Doxygen tweaks Make Doxygen see also macros defined inside struct declarations, and to include also opaque structs. Keep members in the order they are in the .h file, since Doxygen's case-insensitive sort by name jumbles things.
2021-10-06 20:55:04 +03:00
SORT_MEMBER_DOCS = NO
doc: hide various Doxygen generated dot graphs The Doxygen autogenerated graphs are very useful and take up lots of space being on the top, so disable them. Also disable references/referenced by relations, which add clutter. Also hide most macro values.
2021-10-03 15:08:40 +03:00
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
doc: ignore symbols due to Doxygen mis-parsing Ignore some symbols appearing as "Variables", which seem to be due to some mis-parsing.
2021-10-02 20:19:34 +03:00
# Fix up some apparent Doxygen mis-parsing
EXCLUDE_SYMBOLS = "desc" "methods" "msgid_plural" "n" "name" "props" "utils" "start"