From c4b767cba1973880d2ef580e84716b9b324f669c Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Fri, 26 Jun 2026 12:32:59 +0200 Subject: [PATCH] docs: rename pulse module files to fix doxygen \file name collisions Prefix all pulse module source files with pulse- to give them unique basenames, avoiding ambiguous \file suffix matching in doxygen when identically-named files exist under src/modules/. Co-Authored-By: Claude Opus 4.6 --- doc/input-filter.py | 3 +- doc/meson.build | 3 +- src/modules/meson.build | 68 +++++++++---------- ...e-alsa-sink.c => pulse-module-alsa-sink.c} | 0 ...sa-source.c => pulse-module-alsa-source.c} | 0 ...ways-sink.c => pulse-module-always-sink.c} | 0 ...ine-sink.c => pulse-module-combine-sink.c} | 0 ...anager.c => pulse-module-device-manager.c} | 0 ...estore.c => pulse-module-device-restore.c} | 0 ...ho-cancel.c => pulse-module-echo-cancel.c} | 0 ...e-gsettings.c => pulse-module-gsettings.c} | 0 ...etect.c => pulse-module-jackdbus-detect.c} | 0 ...dspa-sink.c => pulse-module-ladspa-sink.c} | 0 ...-source.c => pulse-module-ladspa-source.c} | 0 ...ule-loopback.c => pulse-module-loopback.c} | 0 ...p.c => pulse-module-native-protocol-tcp.c} | 0 ...e-null-sink.c => pulse-module-null-sink.c} | 0 ...e-pipe-sink.c => pulse-module-pipe-sink.c} | 0 ...pe-source.c => pulse-module-pipe-source.c} | 0 ...iscover.c => pulse-module-raop-discover.c} | 0 ...remap-sink.c => pulse-module-remap-sink.c} | 0 ...p-source.c => pulse-module-remap-source.c} | 0 ...-input.c => pulse-module-roc-sink-input.c} | 0 ...ule-roc-sink.c => pulse-module-roc-sink.c} | 0 ...roc-source.c => pulse-module-roc-source.c} | 0 ...ule-rtp-recv.c => pulse-module-rtp-recv.c} | 0 ...ule-rtp-send.c => pulse-module-rtp-send.c} | 0 ...p.c => pulse-module-simple-protocol-tcp.c} | 0 ...estore.c => pulse-module-stream-restore.c} | 0 ...ect.c => pulse-module-switch-on-connect.c} | 0 ...nnel-sink.c => pulse-module-tunnel-sink.c} | 0 ...-source.c => pulse-module-tunnel-source.c} | 0 ...ual-sink.c => pulse-module-virtual-sink.c} | 0 ...source.c => pulse-module-virtual-source.c} | 0 ...ule-x11-bell.c => pulse-module-x11-bell.c} | 0 ...ver.c => pulse-module-zeroconf-discover.c} | 0 ...lish.c => pulse-module-zeroconf-publish.c} | 0 37 files changed, 38 insertions(+), 36 deletions(-) rename src/modules/module-protocol-pulse/modules/{module-alsa-sink.c => pulse-module-alsa-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-alsa-source.c => pulse-module-alsa-source.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-always-sink.c => pulse-module-always-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-combine-sink.c => pulse-module-combine-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-device-manager.c => pulse-module-device-manager.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-device-restore.c => pulse-module-device-restore.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-echo-cancel.c => pulse-module-echo-cancel.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-gsettings.c => pulse-module-gsettings.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-jackdbus-detect.c => pulse-module-jackdbus-detect.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-ladspa-sink.c => pulse-module-ladspa-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-ladspa-source.c => pulse-module-ladspa-source.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-loopback.c => pulse-module-loopback.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-native-protocol-tcp.c => pulse-module-native-protocol-tcp.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-null-sink.c => pulse-module-null-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-pipe-sink.c => pulse-module-pipe-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-pipe-source.c => pulse-module-pipe-source.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-raop-discover.c => pulse-module-raop-discover.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-remap-sink.c => pulse-module-remap-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-remap-source.c => pulse-module-remap-source.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-roc-sink-input.c => pulse-module-roc-sink-input.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-roc-sink.c => pulse-module-roc-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-roc-source.c => pulse-module-roc-source.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-rtp-recv.c => pulse-module-rtp-recv.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-rtp-send.c => pulse-module-rtp-send.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-simple-protocol-tcp.c => pulse-module-simple-protocol-tcp.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-stream-restore.c => pulse-module-stream-restore.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-switch-on-connect.c => pulse-module-switch-on-connect.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-tunnel-sink.c => pulse-module-tunnel-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-tunnel-source.c => pulse-module-tunnel-source.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-virtual-sink.c => pulse-module-virtual-sink.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-virtual-source.c => pulse-module-virtual-source.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-x11-bell.c => pulse-module-x11-bell.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-zeroconf-discover.c => pulse-module-zeroconf-discover.c} (100%) rename src/modules/module-protocol-pulse/modules/{module-zeroconf-publish.c => pulse-module-zeroconf-publish.c} (100%) diff --git a/doc/input-filter.py b/doc/input-filter.py index 9a0101fa6..0792bd1ca 100755 --- a/doc/input-filter.py +++ b/doc/input-filter.py @@ -70,7 +70,8 @@ def main(): res = "\n * ".join(res) text = text.replace("@pulse_module_options@", res) - if os.path.basename(fn).startswith("module-") and fn.endswith(".c"): + basename = os.path.basename(fn) + if (basename.startswith("module-") or basename.startswith("pulse-module-")) and fn.endswith(".c"): text = re.sub(r"^ \* ##", r" * #", text, flags=re.M) print("/** \\privatesection */") diff --git a/doc/meson.build b/doc/meson.build index e5c2936dc..4a6f81976 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -219,7 +219,8 @@ doxygen_env.set('LIBPIPEWIRE_MODULES', '