From be757e90ee0146ff9fa0ceff463ee894a20e951f Mon Sep 17 00:00:00 2001 From: Jeremy Lainé Date: Thu, 9 Dec 2010 15:43:01 +0000 Subject: improve QXmppCallManager code documentation --- src/QXmppCallManager.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'src/QXmppCallManager.h') 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: -- cgit v1.2.3