refs #287 Doxygen "threadsafe" alias command

This commit is contained in:
Mathew Sutcliffe
2014-07-11 17:53:45 +01:00
parent 7b546c7dba
commit 5c1b608391
4 changed files with 37 additions and 36 deletions

View File

@@ -87,19 +87,19 @@ namespace BlackCore
virtual ~IContextApplication() {}
//! Output redirection (redirect my output)
//! \remarks thread safe
//! \threadsafe
RedirectionLevel getOutputRedirectionLevel() const;
//! Output redirection (redirect my output)
//! \remarks thread safe
//! \threadsafe
void setOutputRedirectionLevel(RedirectionLevel redirectionLevel);
//! Redirected output generated by others
//! \remarks thread safe
//! \threadsafe
RedirectionLevel getStreamingForRedirectedOutputLevel() const;
//! Redirected output generated by others
//! \remarks thread safe
//! \threadsafe
void setStreamingForRedirectedOutputLevel(RedirectionLevel redirectionLevel) ;
//! Reset output redirection
@@ -156,11 +156,11 @@ namespace BlackCore
static QtMessageHandler s_oldHandler;
//! Message handler, handles one individual context
//! \remarks thread safe
//! \threadsafe
void messageHandler(QtMsgType type, const QMessageLogContext &messageContext, const QString &messsage);
//! Handle output dispatch, handles all contexts
//! \remarks Can be called in thread, has to be thread safe
//! \threadsafe
static void messageHandlerDispatch(QtMsgType type, const QMessageLogContext &messageContext, const QString &message);
RedirectionLevel m_outputRedirectionLevel; //!< enable / disable my output

View File

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

View File

@@ -30,7 +30,7 @@ namespace BlackMisc
}
//! Thread safe, set update timestamp
//! \remarks thread safe
//! \threadsafe
QDateTime getUpdateTimestamp() const
{
QReadLocker(&this->m_lock);
@@ -38,7 +38,7 @@ namespace BlackMisc
}
//! Thread safe, set update timestamp
//! \remarks thread safe
//! \threadsafe
void setUpdateTimestamp(const QDateTime &updateTimestamp)
{
QWriteLocker(&this->m_lock);
@@ -46,6 +46,7 @@ namespace BlackMisc
}
//! Thread safe, mark as stopped
//! \threadsafe
virtual void stop()
{
if (this->isStopped()) return;
@@ -72,7 +73,7 @@ namespace BlackMisc
}
//! Thread safe, is in state stopped?
//! \remarks thread safe
//! \threadsafe
bool isStopped() const
{
QReadLocker rl(&this->m_lock);
@@ -82,7 +83,7 @@ namespace BlackMisc
/*!
* Set the update time
* \param updatePeriodMs <=0 stops the timer
* \remarks thread safe
* \threadsafe
*/
void setInterval(int updatePeriodMs)
{
@@ -95,7 +96,7 @@ namespace BlackMisc
}
//! Get the timer interval (ms)
//! \remarks thread safe
//! \threadsafe
int interval() const
{
QReadLocker rl(&this->m_lock);
@@ -111,7 +112,7 @@ namespace BlackMisc
}
//! Has pending network replay
//! \remarks thread safe
//! \threadsafe
void setPendingNetworkReply(QNetworkReply *reply)
{
QWriteLocker(&this->m_lock);
@@ -119,7 +120,7 @@ namespace BlackMisc
}
//! Has pending operation
//! \remarks thread safe
//! \threadsafe
void setPendingFuture(QFuture<FutureRet> future)
{
QWriteLocker(&this->m_lock);
@@ -127,7 +128,7 @@ namespace BlackMisc
}
//! Thread safe, mark as to be stopped
//! \remarks thread safe
//! \threadsafe
void setStopFlag()
{
QWriteLocker wl(&this->m_lock);