[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    branches/KDE/3.5/kdelibs/kio/kio
From:       Adriaan de Groot <groot () kde ! org>
Date:       2005-08-23 8:16:45
Message-ID: 1124785005.851535.1748.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 452390 by adridg:

APIDOX fixes: parameter names should match @param, and all parameters should be documented.

 M  +1 -1      dataslave.h  
 M  +6 -3      slave.h  


--- branches/KDE/3.5/kdelibs/kio/kio/dataslave.h #452389:452390
@@ -60,7 +60,7 @@
         virtual void suspend();
         virtual void resume();
         virtual bool suspended();
-        virtual void send(int cmd, const QByteArray &arr = QByteArray());
+        virtual void send(int cmd, const QByteArray &data = QByteArray());
 
 	virtual void hold(const KURL &url);
 
--- branches/KDE/3.5/kdelibs/kio/kio/slave.h #452389:452390
@@ -140,10 +140,13 @@
 	/**
 	 * Creates a new slave.
 	 *
-	 * @param _error is the error code on failure and undefined else.
-	 * @param _error_text is the error text on failure and undefined else.
+	 * @param protocol protocol the slave is for.
+	 * @param url URL the slave should operate on.
+	 * @param error is the error code on failure and undefined else.
+	 * @param error_text is the error text on failure and undefined else.
 	 *
 	 * @return 0 on failure, or a pointer to a slave otherwise.
+	 * @todo What are legal @p protocol values?
 	 */
 	static Slave* createSlave( const QString &protocol, const KURL& url, int& error, QString& error_text );
 
@@ -172,7 +175,7 @@
 	 * @param data byte array containing data
 	 * @since 3.2
 	 */
-        void send(int cmd, const QByteArray &arr = QByteArray());// TODO(BIC): make virtual
+        void send(int cmd, const QByteArray &data = QByteArray());// TODO(BIC): make virtual
 	// == end communication with connected kioslave ==
 
 	/**
[prev in list] [next in list] [prev in thread] [next in thread]