Doxygen fixes

This commit is contained in:
Klaus Basan
2014-07-06 23:22:24 +02:00
parent 3729721fc3
commit b949a2635b
4 changed files with 43 additions and 41 deletions

View File

@@ -77,19 +77,19 @@ namespace BlackCore
virtual ~IContextApplication() {}
//! Output redirection (redirect my output)
//! \threadsafe
//! \remarks thread safe
RedirectionLevel getOutputRedirectionLevel() const;
//! Output redirection (redirect my output)
//! \threadsafe
//! \remarks thread safe
void setOutputRedirectionLevel(RedirectionLevel redirectionLevel);
//! Redirected output generated by others
//! \threadsafe
//! \remarks thread safe
RedirectionLevel getStreamingForRedirectedOutputLevel() const;
//! Redirected output generated by others
//! \threadsafe
//! \remarks thread safe
void setStreamingForRedirectedOutputLevel(RedirectionLevel redirectionLevel) ;
//! Reset output redirection
@@ -146,7 +146,7 @@ namespace BlackCore
static QtMessageHandler s_oldHandler;
//! Message handler, handles one individual context
//! \threadsafe
//! \remarks thread safe
void messageHandler(QtMsgType type, const QMessageLogContext &messageContext, const QString &messsage);
//! Handle output dispatch, handles all contexts

View File

@@ -59,39 +59,39 @@ namespace BlackCore
const QDBusConnection &getDBusConnection() const { return this->m_dbusConnection; }
//! Enable / disable all logging
//! \threadsafe
//! \remarks thread safe
void signalLog(bool enabled);
//! Signal logging for application context
//! \threadsafe
//! \remarks thread safe
bool signalLogForApplication(bool enabled);
//! Signal logging for audio context
//! \threadsafe
//! \remarks thread safe
bool signalLogForAudio(bool enabled);
//! Signal logging for network context
//! \threadsafe
//! \remarks thread safe
bool signalLogForNetwork(bool enabled);
//! Signal logging for own aircraft context
//! \threadsafe
//! \remarks thread safe
bool signalLogForOwnAircraft(bool enabled);
//! Signal logging for settings context
//! \threadsafe
//! \remarks thread safe
bool signalLogForSettings(bool enabled);
//! Signal logging for simulator context
//! \threadsafe
//! \remarks thread safe
bool signalLogForSimulator(bool enabled);
//! Enable / disable all logging
//! \threadsafe
//! \remarks thread safe
void slotLog(bool enabled);
//! Slot logging for application context
//! \threadsafe
//! \remarks thread safe
void slotLogForApplication(bool enabled)
{
QWriteLocker wl(&m_lock);
@@ -99,7 +99,7 @@ namespace BlackCore
}
//! Slot logging for audio context
//! \threadsafe
//! \remarks thread safe
void slotLogForAudio(bool enabled)
{
QWriteLocker wl(&m_lock);
@@ -107,7 +107,7 @@ namespace BlackCore
}
//! Slot logging for network context
//! \threadsafe
//! \remarks thread safe
void slotLogForNetwork(bool enabled)
{
QWriteLocker wl(&m_lock);
@@ -115,7 +115,7 @@ namespace BlackCore
}
//! Slot logging for own aircraft context
//! \threadsafe
//! \remarks thread safe
void slotLogForOwnAircraft(bool enabled)
{
QWriteLocker wl(&m_lock);
@@ -123,7 +123,7 @@ namespace BlackCore
}
//! Slot logging for settings context
//! \threadsafe
//! \remarks thread safe
void slotLogForSettings(bool enabled)
{
QWriteLocker wl(&m_lock);
@@ -131,7 +131,7 @@ namespace BlackCore
}
//! Slot logging for simulator context
//! \threadsafe
//! \remarks thread safe
void slotLogForSimulator(bool enabled)
{
QWriteLocker wl(&m_lock);
@@ -139,7 +139,7 @@ namespace BlackCore
}
//! Slot logging for application context
//! \threadsafe
//! \remarks thread safe
bool isSlotLogForApplicationEnabled() const
{
QReadLocker rl(&m_lock);
@@ -147,7 +147,7 @@ namespace BlackCore
}
//! Slot logging for audio context
//! \threadsafe
//! \remarks thread safe
bool isSlotLogForAudioEnabled() const
{
QReadLocker rl(&m_lock);
@@ -155,7 +155,7 @@ namespace BlackCore
}
//! Slot logging for network context
//! \threadsafe
//! \remarks thread safe
bool isSlotLogForNetworkEnabled() const
{
QReadLocker rl(&m_lock);
@@ -163,7 +163,7 @@ namespace BlackCore
}
//! Slot log for own aircraft
//! \threadsafe
//! \remarks thread safe
bool isSlotLogForOwnAircraftEnabled() const
{
QReadLocker rl(&m_lock);
@@ -171,7 +171,7 @@ namespace BlackCore
}
//! Slot logging for settings context
//! \threadsafe
//! \remarks thread safe
bool isSlotLogForSettingsEnabled() const
{
QReadLocker rl(&m_lock);
@@ -179,7 +179,7 @@ namespace BlackCore
}
//! Slot logging for simulator context
//! \threadsafe
//! \remarks thread safe
bool isSlotLogForSimulatorEnabled() const
{
QReadLocker rl(&m_lock);
@@ -187,7 +187,7 @@ namespace BlackCore
}
//! Slot logging for specified context
//! \threadsafe
//! \remarks thread safe
bool isSlotLogEnabledFor(LogContext context) const;
//! Slot logging

View File

@@ -3,6 +3,8 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
//! \file
#ifndef BLACKCORE_NETWORK_VATLIB_H
#define BLACKCORE_NETWORK_VATLIB_H
@@ -18,17 +20,17 @@
namespace BlackCore
{
/*!
* \brief Implementation of INetwork using the vatlib shim
* Implementation of INetwork using the vatlib shim
*/
class CNetworkVatlib : public INetwork
{
Q_OBJECT
public:
//! \brief Constructor
//! Constructor
CNetworkVatlib(QObject *parent = nullptr);
//! \brief Destructor
//! Destructor
virtual ~CNetworkVatlib();
//! \copydoc INetwork::isConnected()

View File

@@ -30,7 +30,7 @@ namespace BlackMisc
}
//! Thread safe, set update timestamp
//! \threadsafe
//! \remarks thread safe
QDateTime getUpdateTimestamp() const
{
QReadLocker(&this->m_lock);
@@ -38,7 +38,7 @@ namespace BlackMisc
}
//! Thread safe, set update timestamp
//! \threadsafe
//! \remarks thread safe
void setUpdateTimestamp(const QDateTime &updateTimestamp)
{
QWriteLocker(&this->m_lock);
@@ -72,7 +72,7 @@ namespace BlackMisc
}
//! Thread safe, is in state stopped?
//! \threadsafe
//! \remarks thread safe
bool isStopped() const
{
QReadLocker rl(&this->m_lock);
@@ -82,7 +82,7 @@ namespace BlackMisc
/*!
* Set the update time
* \param updatePeriodMs <=0 stops the timer
* \threadsafe
* \remarks thread safe
*/
void setInterval(int updatePeriodMs)
{
@@ -95,7 +95,7 @@ namespace BlackMisc
}
//! Get the timer interval (ms)
//! \threadsafe
//! \remarks thread safe
int interval() const
{
QReadLocker rl(&this->m_lock);
@@ -111,7 +111,7 @@ namespace BlackMisc
}
//! Has pending network replay
//! \threadsafe
//! \remarks thread safe
void setPendingNetworkReply(QNetworkReply *reply)
{
QWriteLocker(&this->m_lock);
@@ -119,7 +119,7 @@ namespace BlackMisc
}
//! Has pending operation
//! \threadsafe
//! \remarks thread safe
void setPendingFuture(QFuture<FutureRet> future)
{
QWriteLocker(&this->m_lock);
@@ -127,19 +127,19 @@ namespace BlackMisc
}
//! Thread safe, mark as to be stopped
//! \threadsafe
//! \remarks thread safe
void setStopFlag()
{
QWriteLocker wl(&this->m_lock);
this->m_stopped = true;
}
QDateTime m_updateTimestamp;
QTimer *m_updateTimer;
bool m_stopped;
QDateTime m_updateTimestamp; //!< when was file / resource read
QTimer *m_updateTimer; //!< update times
bool m_stopped; //!< mark as stopped, threads should terminate
QFuture<FutureRet> m_pendingFuture; //!< optional future to be stopped
QNetworkReply *m_pendingNetworkReply; //!< optional future to be stopped
mutable QReadWriteLock m_lock;
mutable QReadWriteLock m_lock; //!< lock
};
} // namespace