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 <noreply@anthropic.com>
This commit is contained in:
Wim Taymans 2026-06-26 12:32:59 +02:00
parent 2a88fb6ae8
commit c4b767cba1
37 changed files with 38 additions and 36 deletions

View file

@ -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 */")

View file

@ -219,7 +219,8 @@ doxygen_env.set('LIBPIPEWIRE_MODULES', '<ul><li>' + '</li><li>'.join(module_manp
pulse_module_manpage_list = []
foreach m : pipewire_module_protocol_pulse_sources
name = fs.stem(fs.name(m))
if m.contains('/modules/') and name.startswith('module-')
if m.contains('/modules/') and (name.startswith('module-') or name.startswith('pulse-module-'))
name = name.replace('pulse-module-', 'module-')
pagepart = name.replace('-', '_')
pulse_module_manpage_list += f'\\ref page_pulse_@pagepart@ "pipewire-pulse-@name@(7)"'
manpages += [[f'pipewire-pulse-@name@.7', f'page_pulse_@pagepart@']]

View file

@ -332,38 +332,38 @@ pipewire_module_protocol_pulse_sources = [
'module-protocol-pulse/stream.c',
'module-protocol-pulse/utils.c',
'module-protocol-pulse/volume.c',
'module-protocol-pulse/modules/module-alsa-sink.c',
'module-protocol-pulse/modules/module-alsa-source.c',
'module-protocol-pulse/modules/module-always-sink.c',
'module-protocol-pulse/modules/module-combine-sink.c',
'module-protocol-pulse/modules/module-device-manager.c',
'module-protocol-pulse/modules/module-device-restore.c',
'module-protocol-pulse/modules/module-echo-cancel.c',
'module-protocol-pulse/modules/module-jackdbus-detect.c',
'module-protocol-pulse/modules/module-ladspa-sink.c',
'module-protocol-pulse/modules/module-ladspa-source.c',
'module-protocol-pulse/modules/module-loopback.c',
'module-protocol-pulse/modules/module-native-protocol-tcp.c',
'module-protocol-pulse/modules/module-null-sink.c',
'module-protocol-pulse/modules/module-pipe-source.c',
'module-protocol-pulse/modules/module-pipe-sink.c',
'module-protocol-pulse/modules/module-raop-discover.c',
'module-protocol-pulse/modules/module-remap-sink.c',
'module-protocol-pulse/modules/module-remap-source.c',
'module-protocol-pulse/modules/module-roc-sink.c',
'module-protocol-pulse/modules/module-roc-sink-input.c',
'module-protocol-pulse/modules/module-roc-source.c',
'module-protocol-pulse/modules/module-rtp-recv.c',
'module-protocol-pulse/modules/module-rtp-send.c',
'module-protocol-pulse/modules/module-simple-protocol-tcp.c',
'module-protocol-pulse/modules/module-stream-restore.c',
'module-protocol-pulse/modules/module-switch-on-connect.c',
'module-protocol-pulse/modules/module-tunnel-sink.c',
'module-protocol-pulse/modules/module-tunnel-source.c',
'module-protocol-pulse/modules/module-virtual-sink.c',
'module-protocol-pulse/modules/module-virtual-source.c',
'module-protocol-pulse/modules/module-x11-bell.c',
'module-protocol-pulse/modules/module-zeroconf-discover.c',
'module-protocol-pulse/modules/pulse-module-alsa-sink.c',
'module-protocol-pulse/modules/pulse-module-alsa-source.c',
'module-protocol-pulse/modules/pulse-module-always-sink.c',
'module-protocol-pulse/modules/pulse-module-combine-sink.c',
'module-protocol-pulse/modules/pulse-module-device-manager.c',
'module-protocol-pulse/modules/pulse-module-device-restore.c',
'module-protocol-pulse/modules/pulse-module-echo-cancel.c',
'module-protocol-pulse/modules/pulse-module-jackdbus-detect.c',
'module-protocol-pulse/modules/pulse-module-ladspa-sink.c',
'module-protocol-pulse/modules/pulse-module-ladspa-source.c',
'module-protocol-pulse/modules/pulse-module-loopback.c',
'module-protocol-pulse/modules/pulse-module-native-protocol-tcp.c',
'module-protocol-pulse/modules/pulse-module-null-sink.c',
'module-protocol-pulse/modules/pulse-module-pipe-source.c',
'module-protocol-pulse/modules/pulse-module-pipe-sink.c',
'module-protocol-pulse/modules/pulse-module-raop-discover.c',
'module-protocol-pulse/modules/pulse-module-remap-sink.c',
'module-protocol-pulse/modules/pulse-module-remap-source.c',
'module-protocol-pulse/modules/pulse-module-roc-sink.c',
'module-protocol-pulse/modules/pulse-module-roc-sink-input.c',
'module-protocol-pulse/modules/pulse-module-roc-source.c',
'module-protocol-pulse/modules/pulse-module-rtp-recv.c',
'module-protocol-pulse/modules/pulse-module-rtp-send.c',
'module-protocol-pulse/modules/pulse-module-simple-protocol-tcp.c',
'module-protocol-pulse/modules/pulse-module-stream-restore.c',
'module-protocol-pulse/modules/pulse-module-switch-on-connect.c',
'module-protocol-pulse/modules/pulse-module-tunnel-sink.c',
'module-protocol-pulse/modules/pulse-module-tunnel-source.c',
'module-protocol-pulse/modules/pulse-module-virtual-sink.c',
'module-protocol-pulse/modules/pulse-module-virtual-source.c',
'module-protocol-pulse/modules/pulse-module-x11-bell.c',
'module-protocol-pulse/modules/pulse-module-zeroconf-discover.c',
]
if snap_dep.found() and glib2_snap_dep.found() and gio2_snap_dep.found() and apparmor_snap_dep.found()
@ -382,7 +382,7 @@ endif
if avahi_dep.found()
pipewire_module_protocol_pulse_sources += [
'module-protocol-pulse/modules/module-zeroconf-publish.c',
'module-protocol-pulse/modules/pulse-module-zeroconf-publish.c',
]
pipewire_module_protocol_pulse_sources += zeroconf_sources
pipewire_module_protocol_pulse_deps += zeroconf_deps
@ -390,7 +390,7 @@ endif
if gsettings_gio_dep.found()
pipewire_module_protocol_pulse_sources += [
'module-protocol-pulse/modules/module-gsettings.c',
'module-protocol-pulse/modules/pulse-module-gsettings.c',
]
pipewire_module_protocol_pulse_deps += gsettings_gio_dep
cdata.set('HAVE_GIO', true)