Menu
▾
▴
[KMess-commits] SF.net SVN: kmess: [3365] trunk/kmess/src
|
From: <cod...@us...> - 2008-06-29 19:56:24
|
Revision: 3365
http://kmess.svn.sourceforge.net/kmess/?rev=3365&view=rev
Author: codingdomain
Date: 2008-06-29 12:56:30 -0700 (Sun, 29 Jun 2008)
Log Message:
-----------
cleared out many APIDOX warnings from Doxygen
Modified Paths:
--------------
trunk/kmess/src/contact/contactlist.cpp
trunk/kmess/src/dialogs/addemoticondialog.cpp
trunk/kmess/src/emoticon.cpp
trunk/kmess/src/kmessdebug.cpp
trunk/kmess/src/main.cpp
trunk/kmess/src/network/applications/application.cpp
trunk/kmess/src/network/applications/application.h
trunk/kmess/src/network/applications/p2papplication.cpp
trunk/kmess/src/network/applications/p2papplicationbase.cpp
trunk/kmess/src/network/msnconnection.cpp
trunk/kmess/src/network/msnconnection.h
trunk/kmess/src/network/msnnotificationconnection.cpp
trunk/kmess/src/network/msnsockettcp.cpp
trunk/kmess/src/network/soap/httpsoapconnection.cpp
trunk/kmess/src/network/soap/offlineimservice.cpp
trunk/kmess/src/network/soap/passportloginservice.cpp
trunk/kmess/src/settings/accountsmanagerpage.cpp
trunk/kmess/src/settings/emoticonspage.cpp
trunk/kmess/src/utils/kmessshared.cpp
trunk/kmess/src/utils/thumbnailprovider.cpp
Modified: trunk/kmess/src/contact/contactlist.cpp
===================================================================
--- trunk/kmess/src/contact/contactlist.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/contact/contactlist.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -446,7 +446,7 @@
/**
* Emits the Data Changed signal on some items
*
- * @param item The list of items which changed
+ * @param itemList The list of items which changed
*/
void ContactList::forwardDataChanged( ModelItemList itemList )
{
Modified: trunk/kmess/src/dialogs/addemoticondialog.cpp
===================================================================
--- trunk/kmess/src/dialogs/addemoticondialog.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/dialogs/addemoticondialog.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -44,7 +44,6 @@
*
* @param theme Theme to add the new emoticon to
* @param parent Parent widget
- * @param name Qt object name
*/
AddEmoticonDialog::AddEmoticonDialog( EmoticonTheme *theme, QWidget *parent )
: KDialog( parent )
@@ -181,7 +180,7 @@
* Preselects a file name and an emoticon shortcut in the dialog
*
* @param pictureName Full path to the file that will be added
- * @param code Emoticon shortcut to preselect
+ * @param shortcut Emoticon shortcut to preselect
*/
void AddEmoticonDialog::preSelect( QString pictureName, QString shortcut )
{
Modified: trunk/kmess/src/emoticon.cpp
===================================================================
--- trunk/kmess/src/emoticon.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/emoticon.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -85,9 +85,7 @@
/**
* Create an exact copy of another emoticon
*
- * @param pictureName The picture file name
- * @param tooltip The name of this emoticon, which will be displayed as tooltip in the Emoticon Sidebar
- * @param pictureDirectory The folder where this emoticon's image is located
+ * @param other The object to copy
*/
Emoticon::Emoticon( const Emoticon &other )
: QObject()
@@ -118,7 +116,7 @@
/**
* Add a text shortcut which will translate to this emoticon
*
- * @param text Shortcut text
+ * @param shortcut Shortcut text
*/
void Emoticon::addShortcut( QString shortcut )
{
Modified: trunk/kmess/src/kmessdebug.cpp
===================================================================
--- trunk/kmess/src/kmessdebug.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/kmessdebug.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -83,7 +83,7 @@
* Unlike Q_ASSERT(), this function won't crash KMess,
* since it could be trigged by an invalid client
*
- * @param condition The source code of the condition passed to the <code>KMESS_ASSERT</code> macro.
+ * @param assertion The source code of the condition passed to the <code>KMESS_ASSERT</code> macro.
* @param file The filename where the <code>KMESS_ASSERT</code> macro is called from.
* @param line The line number where the <code>KMESS_ASSERT</code> macro is called from.
* @ingroup Debug
Modified: trunk/kmess/src/main.cpp
===================================================================
--- trunk/kmess/src/main.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/main.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -29,7 +29,7 @@
/**
* @brief Main starting point of KMess.
* @param argc Number of arguments entered at the command line.
- * @param argc Array of command line arguments.
+ * @param argv Array of command line arguments.
* @returns Exit code of the application.
* @ingroup Root
*/
Modified: trunk/kmess/src/network/applications/application.cpp
===================================================================
--- trunk/kmess/src/network/applications/application.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/applications/application.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -619,7 +619,9 @@
* It emits the appMessage() signal
* The chat themes display these messages as "notification" message.
*
- * @param message The message to display.
+ * @param message The message to display.
+ * @param contents A brief indication of the contents. This is used for notifications.
+ * @param isIncoming Whether the message is incoming (true), or outgoing (false).
*/
void Application::showEventMessage( const QString &message, const ChatMessage::ContentsClass contents, bool isIncoming )
{
@@ -635,7 +637,9 @@
* - invitation type not supported.
* - the contact is offline.
*
- * @param message The message to display.
+ * @param message The message to display.
+ * @param contents A brief indication of the contents. This is used for notifications.
+ * @param isIncoming Whether the message is incoming (true), or outgoing (false).
*/
void Application::showSystemMessage( const QString &message, const ChatMessage::ContentsClass contents, bool isIncoming )
{
Modified: trunk/kmess/src/network/applications/application.h
===================================================================
--- trunk/kmess/src/network/applications/application.h 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/applications/application.h 2008-06-29 19:56:30 UTC (rev 3365)
@@ -204,7 +204,7 @@
signals: // Signals
/**
* Signal that this application likes to display a message
- * @param html The HTML message to display.
+ * @param message The message to display.
*/
void applicationMessage( const ChatMessage &message );
Modified: trunk/kmess/src/network/applications/p2papplication.cpp
===================================================================
--- trunk/kmess/src/network/applications/p2papplication.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/applications/p2papplication.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -323,8 +323,8 @@
* - ACK of a SLP error message invokes gotAck_slpError().
* - all other ACKs are not treated specially.
*
- * @param message The ACK message.
- * @param messageType The type of the original message this ACK corresponds with.
+ * @param message The ACK message.
+ * @param ackedMessageType The type of the original message this ACK corresponds with.
*/
void P2PApplication::gotAck(const P2PMessage &message, const P2PMessageType ackedMessageType)
{
@@ -869,8 +869,6 @@
* @brief Called internally after all data is received.
*
* It determines how to continue the session.
- *
- * @param message The received data message.
*/
void P2PApplication::gotDataAckSent()
{
Modified: trunk/kmess/src/network/applications/p2papplicationbase.cpp
===================================================================
--- trunk/kmess/src/network/applications/p2papplicationbase.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/applications/p2papplicationbase.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -1694,6 +1694,7 @@
* @param footerCode The message footer, which is appended when the message is sent over the switchboard.
* @param messageType The type of the message. This value is stored with in the unacked message queue.
* This value is used later to respond to ACKs of certain special messages.
+ * @param messageID Optional message ID to enforce. If nothing is selected, the next available message ID will be used automatically.
* @return Whether the message can be sent. If the socket would block, false is returned.
* This only occurs for direct connections connections.
*/
Modified: trunk/kmess/src/network/msnconnection.cpp
===================================================================
--- trunk/kmess/src/network/msnconnection.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/msnconnection.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -40,7 +40,7 @@
*
* Initializes the sockets, buffers and ping timer.
*
- * @param name The Qt object name.
+ * @param serverType The type of server connection: TCP or HTTP.
*/
MsnConnection::MsnConnection( MsnSocketBase::ServerType serverType )
: QObject(0)
Modified: trunk/kmess/src/network/msnconnection.h
===================================================================
--- trunk/kmess/src/network/msnconnection.h 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/msnconnection.h 2008-06-29 19:56:30 UTC (rev 3365)
@@ -215,8 +215,8 @@
* The last argument of <code>command</code> can be ignored.
* It indicates the size of the payload, in this case 67 bytes.
*
- * @param command The received command and it's arguments.
- * @param payload The message payload which followed the command.
+ * @param command The received command and it's arguments.
+ * @param messageData The message payload which followed the command.
*/
virtual void parsePayloadMessage(const QStringList &command, const QByteArray &messageData) = 0;
// Send a command to the server, returning the ack
Modified: trunk/kmess/src/network/msnnotificationconnection.cpp
===================================================================
--- trunk/kmess/src/network/msnnotificationconnection.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/msnnotificationconnection.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -114,7 +114,7 @@
* It's possible to add a contact to multiple groups,
* typically referred to as "copy contact to group..".
*
- * @param contact The contact.
+ * @param handle The contact handle.
* @param groupId The group ID.
*/
void MsnNotificationConnection::addContactToGroup(QString handle, QString groupId)
Modified: trunk/kmess/src/network/msnsockettcp.cpp
===================================================================
--- trunk/kmess/src/network/msnsockettcp.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/msnsockettcp.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -474,7 +474,7 @@
* Closes the connection, and displays
* the "could not connect to the MSN Messenger service." message box.
*
- * @param error The system error.
+ * @param errorCode The system error.
*/
void MsnSocketTcp::slotSocketError( QAbstractSocket::SocketError errorCode )
{
Modified: trunk/kmess/src/network/soap/httpsoapconnection.cpp
===================================================================
--- trunk/kmess/src/network/soap/httpsoapconnection.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/soap/httpsoapconnection.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -51,7 +51,6 @@
*
* @param endpoint The endpoint of the webservice, should be a http:// or https:// URL.
* @param parent The Qt parent object. The object is deleted when the parent is deleted.
- * @param name The Qt object name, for debugging signals.
*/
HttpSoapConnection::HttpSoapConnection( const QString &endpoint, QObject *parent )
: QObject( parent )
Modified: trunk/kmess/src/network/soap/offlineimservice.cpp
===================================================================
--- trunk/kmess/src/network/soap/offlineimservice.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/soap/offlineimservice.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -388,6 +388,7 @@
* Other unrecognized response types result in a warning message at the console.
*
* @param resultRoot The result root of the SOAP response.
+ * @param headerNode The header node of the SOAP response.
*/
void OfflineImService::parseSoapResult( const QDomElement &resultRoot, const QDomElement &/*headerNode*/ )
{
Modified: trunk/kmess/src/network/soap/passportloginservice.cpp
===================================================================
--- trunk/kmess/src/network/soap/passportloginservice.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/network/soap/passportloginservice.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -139,7 +139,7 @@
* to fire a loginIncorrect() signal instead of requestFailed().
*
* It also traps SOAP fauls which are used to redirect the client.
- * So far this has been observed with @msn.com passport accounts.
+ * So far this has been observed with \@msn.com passport accounts.
*
* The SOAP fault for an incorrect login looks like:
* @code
Modified: trunk/kmess/src/settings/accountsmanagerpage.cpp
===================================================================
--- trunk/kmess/src/settings/accountsmanagerpage.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/settings/accountsmanagerpage.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -113,11 +113,7 @@
/**
- * Delete the given account
- *
- * Giving no arguments causes the currently selected list item to be deleted
- *
- * @param account The account to delete
+ * Delete the currently selected account
*/
void AccountsManagerPage::deleteAccount()
{
Modified: trunk/kmess/src/settings/emoticonspage.cpp
===================================================================
--- trunk/kmess/src/settings/emoticonspage.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/settings/emoticonspage.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -42,7 +42,6 @@
* Constructor
*
* @param parent Parent widget
- * @param name Qt object name
*/
EmoticonsPage::EmoticonsPage( QWidget* parent )
: QWidget(parent)
Modified: trunk/kmess/src/utils/kmessshared.cpp
===================================================================
--- trunk/kmess/src/utils/kmessshared.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/utils/kmessshared.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -278,7 +278,8 @@
*
* The program which will open the URL is the one selected in the Global Settings
*
- * @param url The URL to open
+ * @param folder The folder to open.
+ * @param useHotmail Whether Hotmail can be used to access the e-mail for this account.
*/
void KMessShared::openEmailClient( const QString folder, bool useHotmail )
{
Modified: trunk/kmess/src/utils/thumbnailprovider.cpp
===================================================================
--- trunk/kmess/src/utils/thumbnailprovider.cpp 2008-06-29 18:30:15 UTC (rev 3364)
+++ trunk/kmess/src/utils/thumbnailprovider.cpp 2008-06-29 19:56:30 UTC (rev 3365)
@@ -42,7 +42,6 @@
* @param fileName Name of the file to request.
* @param size Size of the thumbnails. Windows Live Messenger also uses 96x96 thumbnails for all files.
* Depending on it's "file preview size" setting, it scales the received images down afterwards.
- * @param fallback Whether to return a fallback icon instead. This is a generic file type icon also used in the Konqueror.
*/
ThumbnailProvider::ThumbnailProvider( const QString &fileName, int size )
: QObject( 0 )
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|