mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-12-16 08:56:45 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: make Doxygen to show only symbols defined in headers

Browse source 
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.
This commit is contained in:
Pauli Virtanen 2021-10-02 19:24:17 +03:00
parent 1ba805ac7e
commit c345d1e11d
4 changed files with 26 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/input-filter.sh Executable file
View file

@ -0,0 +1,10 @@
#!/bin/bash
#
# Doxygen input filter that adds \privatesection to all files,
# and removes macros.
#
# This is used for .c files, and causes Doxygen to not include
# any symbols from them, unless they also appeared in a header file.
#
echo -n "/** \privatesection */ "
sed -e 's/#define.*//' < "$1"