status/volume: Document public function

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/2380>
This commit is contained in:
Florian Müllner 2022-07-15 14:23:23 +02:00
parent b0187d4261
commit d80a7224cd

View File

@ -19,6 +19,9 @@ const VolumeType = {
// Each Gvc.MixerControl is a connection to PulseAudio, // Each Gvc.MixerControl is a connection to PulseAudio,
// so it's better to make it a singleton // so it's better to make it a singleton
let _mixerControl; let _mixerControl;
/**
* @returns {Gvc.MixerControl} - the mixer control singleton
*/
function getMixerControl() { function getMixerControl() {
if (_mixerControl) if (_mixerControl)
return _mixerControl; return _mixerControl;