aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2010-12-09 15:43:01 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2010-12-09 15:43:01 +0000
commitbe757e90ee0146ff9fa0ceff463ee894a20e951f (patch)
tree58a1c46d3882daff454ef83974ed996a9b434e4c /src
parent4bfbee95e33b5344f8c0041f8c4dcda2e865e696 (diff)
downloadqxmpp-be757e90ee0146ff9fa0ceff463ee894a20e951f.tar.gz
improve QXmppCallManager code documentation
Diffstat (limited to 'src')
-rw-r--r--src/QXmppCallManager.cpp7
-rw-r--r--src/QXmppCallManager.h13
2 files changed, 14 insertions, 6 deletions
diff --git a/src/QXmppCallManager.cpp b/src/QXmppCallManager.cpp
index d2627ca9..28ff0f71 100644
--- a/src/QXmppCallManager.cpp
+++ b/src/QXmppCallManager.cpp
@@ -278,6 +278,11 @@ bool QXmppCallManagerPrivate::sendRequest(QXmppCall *call, const QXmppJingleIq &
return q->client()->sendPacket(iq);
}
+/// Constructs a QXmppCallManager object to handle incoming and outgoing
+/// Voice-Over-IP calls.
+///
+/// \param client
+
QXmppCallManager::QXmppCallManager(QXmppClient *client)
{
d = new QXmppCallManagerPrivate(this);
@@ -288,6 +293,8 @@ QXmppCallManager::QXmppCallManager(QXmppClient *client)
Q_UNUSED(check);
}
+/// Destroys the QXmppCallManager object.
+
QXmppCallManager::~QXmppCallManager()
{
delete d;
diff --git a/src/QXmppCallManager.h b/src/QXmppCallManager.h
index b38123b4..dbeacc10 100644
--- a/src/QXmppCallManager.h
+++ b/src/QXmppCallManager.h
@@ -78,26 +78,27 @@ public:
QXmppRtpChannel *audioChannel() const;
signals:
- /// This signal is emitted when a call is connected.
+ /// \brief This signal is emitted when a call is connected.
///
/// Once this signal is emitted, you can connect a QAudioOutput and
/// QAudioInput to the call. You can determine the appropriate clockrate
/// and the number of channels by calling payloadType().
void connected();
- /// This signal is emitted when a call is finished.
+ /// \brief This signal is emitted when a call is finished.
///
/// Note: Do not delete the call in the slot connected to this signal,
/// instead use deleteLater().
void finished();
- /// \internal
+ /// \cond
void localCandidatesChanged();
+ /// \endcond
- /// This signal is emitted when the remote party is ringing.
+ /// \brief This signal is emitted when the remote party is ringing.
void ringing();
- /// This signal is emitted when the call state changes.
+ /// \brief This signal is emitted when the call state changes.
void stateChanged(QXmppCall::State state);
public slots:
@@ -149,7 +150,7 @@ signals:
/// This signal is emitted when a new incoming call is received.
///
/// To accept the call, invoke the call's QXmppCall::accept() method.
- /// To refuse the call, invoke the call's QXmppCall::abort() method.
+ /// To refuse the call, invoke the call's QXmppCall::hangup() method.
void callReceived(QXmppCall *call);
private slots: