flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-05-04 08:55:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix doxygen warnings

Browse Source 
Fixes #188
This commit is contained in:
Mat Sutcliffe
2023-02-05 16:32:51 +00:00
committed by Lars Toenning
parent 5e5b3f830d
commit 7691e42a5b
175 changed files with 570 additions and 664 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/blackcore/afv/audio/callsigndelaycache.h
View File

@@ -32,8 +32,8 @@ namespace BlackCore::Afv::Audio
//! Success
void success(const QString &callsign);
//! Delay plus/minus
//! @{
//! Delay plus/minus
void increaseDelayMs(const QString &callsign);
void decreaseDelayMs(const QString &callsign);
//! @}

4
src/blackcore/afv/audio/callsignsampleprovider.h
View File

@@ -49,8 +49,8 @@ namespace BlackCore::Afv::Audio
//! Type
const QString &type() const { return m_aircraftType; }
//! Is active?
//! @{
//! Is active?
void active(const QString &callsign, const QString &aircraftType);
void activeSilent(const QString &callsign, const QString &aircraftType);
//! @}
@@ -58,8 +58,8 @@ namespace BlackCore::Afv::Audio
//! Clean
void clear();
//! Add samples
//! @{
//! Add samples
void addOpusSamples(const IAudioDto &audioDto, float distanceRatio);
void addSilentSamples(const IAudioDto &audioDto);
//! @}

6
src/blackcore/afv/audio/input.h
View File

@@ -92,16 +92,16 @@ namespace BlackCore::Afv::Audio
this->stop();
}
//! Number of encoded bytes
//! @{
//! Number of encoded bytes
int opusBytesEncoded() const { return m_opusBytesEncoded; }
void setOpusBytesEncoded(int opusBytesEncoded) { m_opusBytesEncoded = opusBytesEncoded; }
//! @}
//! @{
//! Gain ratio, value a amplitude need to be multiplied with
//! \see http://www.sengpielaudio.com/calculator-amplification.htm
//! \remark gain ratio is voltage ratio/or amplitude ratio, something between 0.001-7.95 for -60dB to 80dB
//! @{
double getGainRatio() const { return m_gainRatio; }
bool setGainRatio(double gainRatio);
//! @}
@@ -110,8 +110,8 @@ namespace BlackCore::Afv::Audio
// bool setVolume(double volume);
/* disabled as not needed
//! The device's volume 0..1
//! @{
//! The device's volume 0..1
double getDeviceInputVolume() const;
bool setDeviceInputVolume(double volume);
//! @}

2
src/blackcore/afv/audio/output.h
View File

@@ -86,8 +86,8 @@ namespace BlackCore::Afv::Audio
const BlackMisc::Audio::CAudioDeviceInfo &device() const { return m_device; }
/* disabled as not used
//! The device's volume 0..1
//! @{
//! The device's volume 0..1
double getDeviceOutputVolume() const;
bool setDeviceOutputVolume(double volume);
//! @}

4
src/blackcore/afv/audio/receiversampleprovider.h
View File

@@ -56,8 +56,8 @@ namespace BlackCore::Afv::Audio
//! Volume
double volume() const { return 1.0; }
//! Mute
//! @{
//! Mute
bool getMute() const { return m_mute; }
void setMute(bool value);
//! @}
@@ -65,8 +65,8 @@ namespace BlackCore::Afv::Audio
//! \copydoc BlackSound::SampleProvider::ISampleProvider::readSamples
virtual int readSamples(QVector<float> &samples, qint64 count) override;
//! Add samples
//! @{
//! Add samples
void addOpusSamples(const IAudioDto &audioDto, uint frequency, float distanceRatio);
void addSilentSamples(const IAudioDto &audioDto, uint frequency, float distanceRatio);
//! @}