Fixed Doxygen

This commit is contained in:
Klaus Basan
2014-01-21 17:44:24 +01:00
parent 17b6789d4e
commit 0e519dbeff
2 changed files with 28 additions and 24 deletions

View File

@@ -11,6 +11,7 @@
#include "blackmisc/vvoiceroomlist.h"
#include "blackmisc/nwuserlist.h"
#include "blackmisc/aviocomsystem.h"
#include "blackmisc/avcallsignlist.h"
#include "blackcore/voice_vatlib.h"
#include <QObject>
#include <QDBusAbstractInterface>
@@ -103,21 +104,18 @@ namespace BlackCore
/*!
* Get voice rooms for COM1, COM2:
* From this connection status etc. can be obtained
* \return
* From this connection audio status can be obtained
*/
virtual BlackMisc::Voice::CVoiceRoomList getComVoiceRoomsWithAudioStatus();
/*!
* Get voice rooms for COM1, COM2, but not with the latest status
* \return
* Get voice rooms for COM1, COM2, but without latest audio status
* \return all voice rooms
*/
virtual BlackMisc::Voice::CVoiceRoomList getComVoiceRooms() const;
/*!
* \brief Set voice rooms
* \param voiceRoomCom1
* \param voiceRoomCom2
*/
virtual void setComVoiceRooms(const BlackMisc::Voice::CVoiceRoom &voiceRoomCom1, const BlackMisc::Voice::CVoiceRoom &voiceRoomCom2);
@@ -127,45 +125,49 @@ namespace BlackCore
virtual void leaveAllVoiceRooms();
/*!
* \brief COM1 room users
* \return
* \brief COM1 room users callsigns
*/
virtual QList<BlackMisc::Aviation::CCallsign> getCom1RoomCallsigns() const;
virtual BlackMisc::Aviation::CCallsignList getCom1RoomCallsigns() const;
/*!
* \brief COM2 room users callsigns
*/
virtual BlackMisc::Aviation::CCallsignList getCom2RoomCallsigns() const;
/*!
* \brief COM1 room users
*/
virtual BlackMisc::Network::CUserList getCom1RoomUsers() const;
/*!
* \brief COM2 room users
* \return
*/
virtual QList<BlackMisc::Aviation::CCallsign> getCom2RoomCallsigns() const;
virtual BlackMisc::Network::CUserList getCom2RoomUsers() const;
/*!
* \brief Audio devices
* \return
*/
virtual BlackMisc::Voice::CAudioDeviceList getAudioDevices() const;
/*!
* \brief Set current audio device
* \param audioDevice
* \brief Get current audio device
* \return input and output devices
*/
virtual BlackMisc::Voice::CAudioDeviceList getCurrentAudioDevices() const;
/*!
* \brief Set current audio device
* \param audioDevice
* \param audioDevice can be input or audio device
*/
virtual void setCurrentAudioDevice(const BlackMisc::Voice::CAudioDevice &audioDevice);
/*!
* \brief Set volumnes
* \param com1
* \param com2
* \brief Set volumnes for COM1/2
*/
virtual void setVolumes(const BlackMisc::Aviation::CComSystem &com1, const BlackMisc::Aviation::CComSystem &com2);
/*!
* \brief Is muted?
* \return
*/
virtual bool isMuted() const;

View File

@@ -156,21 +156,17 @@ namespace BlackCore
virtual void leaveAllVoiceRooms() = 0;
/*!
* \brief Set room output volume
* \param comUnit
* \param volumne
* \brief Set room output volume for COM unit
*/
virtual void setRoomOutputVolume(const ComUnit comUnit, const qint32 volumne) = 0;
/*!
* \brief Start transmitting
* \param comUnit
*/
virtual void startTransmitting(const ComUnit comUnit) = 0;
/*!
* \brief Stop transmitting
* \param comUnit
*/
virtual void stopTransmitting(const ComUnit comUnit) = 0;
@@ -202,7 +198,13 @@ namespace BlackCore
void userLeftRoom(const BlackMisc::Aviation::CCallsign &callsign);
// Audio signals
/*!
* \brief Audio for given unit started
*/
void audioStarted(const ComUnit comUnit);
/*!
* \brief Audio for given unit stopped
*/
void audioStopped(const ComUnit comUnit);
void globalAudioStarted();
void globalAudioStopped();