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

[doxygen] Fix broken groupings

Browse Source
This commit is contained in:
Mat Sutcliffe
2020-08-01 19:08:08 +01:00
parent faf7f2a2cf
commit 2ae0352e75
115 changed files with 474 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/blacksound/audioutilities.h
View File

@@ -20,7 +20,8 @@
namespace BlackSound
{
//! Conversion functions @{
//! Conversion functions
//! @{
BLACKSOUND_EXPORT QVector<float> convertBytesTo32BitFloatPCM(const QByteArray &input);
BLACKSOUND_EXPORT QVector<qint16> convertBytesTo16BitPCM(const QByteArray &input);
BLACKSOUND_EXPORT QVector<qint16> convertFloatBytesTo16BitPCM(const QByteArray &input);
@@ -36,7 +37,8 @@ namespace BlackSound
BLACKSOUND_EXPORT const QString &toQString(QAudioFormat::SampleType s);
//! @}
//! Normalize audio volume to 0..100 @{
//! Normalize audio volume to 0..100
//! @{
BLACKSOUND_EXPORT double normalize0to100(double in);
BLACKSOUND_EXPORT qreal normalize0to100qr(double in);
//! @}

3
src/blacksound/codecs/opusdecoder.h
View File

@@ -30,7 +30,8 @@ namespace BlackSound
//! Dtor
~COpusDecoder();
//! Not copyable and assignable @{
//! Not copyable and assignable
//! @{
COpusDecoder(const COpusDecoder &decoder) = delete;
COpusDecoder& operator=(COpusDecoder const&) = delete;
//! @}

6
src/blacksound/dsp/SimpleComp.h
View File

@@ -46,13 +46,15 @@ namespace chunkware_simple
//! Dtor
virtual ~SimpleComp() {}
//! @{ set parameters
//! set parameters
//! @{
virtual void setThresh(double dB);
virtual void setRatio(double dB);
void setMakeUpGain(double gain);
//! @}
//! @{ get parameters
//! get parameters
//! @{
virtual double getThresh(void) const { return threshdB_; }
virtual double getRatio(void) const { return ratio_; }
double getMakeUpGain(void) const { return makeUpGain_; }

9
src/blacksound/dsp/SimpleEnvelope.h
View File

@@ -91,17 +91,20 @@ namespace chunkware_simple
//! Dtor
virtual ~AttRelEnvelope() {}
//! Attack time constant @{
//! Attack time constant
//! @{
virtual void setAttack(double ms);
virtual double getAttack(void) const { return att_.getTc(); }
//! @}
//! Release time constant @{
//! Release time constant
//! @{
virtual void setRelease(double ms);
virtual double getRelease(void) const { return rel_.getTc(); }
//! @}
//! Sample rate dependencies @{
//! Sample rate dependencies
//! @{
virtual void setSampleRate(double sampleRate);
virtual double getSampleRate(void) const { return att_.getSampleRate(); }
//! @}

9
src/blacksound/dsp/SimpleLimit.h
View File

@@ -48,13 +48,15 @@ namespace chunkware_simple
//! Dtor
virtual ~SimpleLimit() {}
//! @{ set parameters
//! set parameters
//! @{
virtual void setThresh(double dB);
virtual void setAttack(double ms) { this->setAttackImpl(ms); } // used in ctor
virtual void setRelease(double ms);
//! @}
//! @{ get parameters
//! get parameters
//! @{
virtual double getThresh(void) const { return threshdB_; }
virtual double getAttack(void) const { return att_.getTc(); }
virtual double getRelease(void) const { return rel_.getTc(); }
@@ -63,7 +65,8 @@ namespace chunkware_simple
//! get latency
virtual unsigned int getLatency(void) const { return peakHold_; }
//! @{ sample rate
//! sample rate
//! @{
virtual void setSampleRate(double sampleRate);
virtual double getSampleRate(void) { return att_.getSampleRate(); }
//! @}

6
src/blacksound/dsp/biquadfilter.h
View File

@@ -27,14 +27,16 @@ namespace BlackSound
//! Transform
float transform(float inSample);
//! Set filter parameters @{
//! Set filter parameters
//! @{
void setCoefficients(double aa0, double aa1, double aa2, double b0, double b1, double b2);
void setLowPassFilter(float sampleRate, float cutoffFrequency, float q);
void setPeakingEq(float sampleRate, float centreFrequency, float q, float dbGain);
void setHighPassFilter(float sampleRate, float cutoffFrequency, float q);
//! @}
//! Get filters @{
//! Get filters
//! @{
static BiQuadFilter lowPassFilter(float sampleRate, float cutoffFrequency, float q);
static BiQuadFilter highPassFilter(float sampleRate, float cutoffFrequency, float q);
static BiQuadFilter peakingEQ(float sampleRate, float centreFrequency, float q, float dbGain);

3
src/blacksound/sampleprovider/equalizersampleprovider.h
View File

@@ -43,7 +43,8 @@ namespace BlackSound
//! Bypassing?
void setBypassEffects(bool value) { m_bypass = value; }
//! Gain @{
//! Gain
//! @{
double outputGain() const;
void setOutputGain(double outputGain);
//! @}

8
src/blacksound/sampleprovider/resourcesoundsampleprovider.h
View File

@@ -32,12 +32,14 @@ namespace BlackSound
//! copydoc ISampleProvider::isFinished
virtual bool isFinished() const override { return m_isFinished; }
//! Looping @{
//! Looping
//! @{
bool looping() const { return m_looping; }
void setLooping(bool looping) { m_looping = looping; }
// @}
//! @}
//! Gain @{
//! Gain
//! @{
double gain() const { return m_gain; }
void setGain(double gain) { m_gain = gain; }
//! @}

6
src/blacksound/sampleprovider/samples.h
View File

@@ -32,7 +32,8 @@ namespace BlackSound
//! Avoid to copy
Samples(const Samples &) = delete;
//! Various samples (sounds) @{
//! Various samples (sounds)
//! @{
const CResourceSound &crackle() const { return m_crackle; }
const CResourceSound &click() const { return m_click; }
const CResourceSound &whiteNoise() const { return m_whiteNoise; }
@@ -42,7 +43,8 @@ namespace BlackSound
//! Play the click sound
bool playClick() const { return m_audioSettings.get().pttClickUp(); }
//! File names @{
//! File names
//! @{
static const QString &fnCrackle() { static const QString f = "afv_crackle_f32.wav"; return f; }
static const QString &fnClick() { static const QString f = "afv_click_f32.wav"; return f; }
static const QString &fnWhiteNoise() { static const QString f = "afv_whitenoise_f32.wav"; return f; }