mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-10-29 05:40:27 -04:00
7123fadc37
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.
32 lines
1.5 KiB
Bash
Executable file
32 lines
1.5 KiB
Bash
Executable file
#!/bin/bash
|
|
#
|
|
# Doxygen input filter, which tries to fix documentation of callback
|
|
# method macros.
|
|
#
|
|
# This is used for .h files.
|
|
#
|
|
|
|
FILENAME="$1"
|
|
|
|
# Add \ingroup commands for the file, for each \addgroup in it
|
|
BASEFILE=$(echo "$FILENAME" | sed -e 's@.*src/pipewire/@pipewire/@; s@.*spa/include/spa/@spa/@; s@.*src/test/@test/@;')
|
|
|
|
echo "/** \file"
|
|
echo "\`$BASEFILE\`"
|
|
sed -n -e '/.*\\addtogroup [a-zA-Z0-9_].*/ { s/.*addtogroup /\\ingroup /; p; }' < "$FILENAME" | sort | uniq
|
|
echo " */"
|
|
|
|
# Add \sa and \copydoc for (struct *methods) callback macros.
|
|
# #define pw_core_add_listener(...) pw_core_method(c,add_listener,...) -> add \sa and \copydoc
|
|
# #define spa_system_read(...) spa_system_method_r(c,read,...) -> add \sa and \copydoc
|
|
#
|
|
# Also:
|
|
# Ensure all macros are included (also those defined inside a struct),
|
|
# by adding /** \ingroup XXX */ before each definition.
|
|
# Also ensure all opaque structs get included.
|
|
sed -e 's@^\(#define .*[[:space:]]\)\(.*_method\)\((.,[[:space:]]*\)\([a-z_]\+\)\(.*)[[:space:]]*\)$@\1\2\3\4\5 /**< \\copydoc \2s.\4\n\n\\sa \2s.\4 */@;' \
|
|
-e 's@^\(#define .*[[:space:]]\)\(.*_method\)\(_[rvs](.,[[:space:]]*\)\([a-z_]\+\)\(.*)[[:space:]]*\)$@\1\2\3\4\5 /**< \\copydoc \2s.\4\n\n\\sa \2s.\4 */@;' \
|
|
-e '/\\addtogroup/ { h; s@.*\\addtogroup \(.*\).*@/** \\ingroup \1 */@; x; }' \
|
|
-e '/#define \(PW\|SPA\)_[A-Z].*[^\\][ ]*$/ { x; p; x; }' \
|
|
-e 's@^\([ ]*struct \)\([a-zA-Z0-9_]*\)\(;.*\)$@/** \\struct \2 */\n\1\2\3@;' \
|
|
< "$FILENAME"
|