[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-devel
Subject: Re: KUtils docs
From: Thomas Kadauke <tkadauke () gmx ! de>
Date: 2005-10-18 20:52:34
Message-ID: 200510182252.34574.tkadauke () gmx ! de
[Download RAW message or body]
Hi!
I've got more :) These are dox fixes which were really easy. Mostly "name"
parameter stuff. This is against /trunk/KDE/kdelibs. I wasn't able to fix all
errors in the log. It looks like a lot of this is still under construction.
So I will check the log again tomorrow :)
--Thomas
Am Tuesday 18 October 2005 16:58 schrieb Frans Englich:
> On Tuesday 18 October 2005 12:24, Thomas Kadauke wrote:
> > Hi all,
> >
> > Attached is a small patch (against kdelibs/kutils) for the
> > KCModuleProxyIface, KCModuleProxyRootDispatcher and KCModuleLoader
> > classes' API dox. Because of a wrongly used @class tag for the short
> > description, these classes were shown as "DCOP" and "Loads" in the
> > summary with no further documentation at all.
>
> Thanks, applied.
>
> Work on doxygen, how honorable.
>
>
> Cheers,
>
> Frans
>
> >> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to
> >> unsubscribe <<
["kdelibs4doc.diff" (text/x-diff)]
Index: interfaces/ktexteditor/cursorfeedback.h
===================================================================
--- interfaces/ktexteditor/cursorfeedback.h (revision 471795)
+++ interfaces/ktexteditor/cursorfeedback.h (working copy)
@@ -73,8 +73,8 @@
* The character immediately surrounding the cursor was deleted.
* If both characters are simultaneously deleted, positionDeleted() is called \
instead.
*
- * \param before true if the character immediately before was deleted, false if \
the
- * character immediately after was deleted.
+ * \param deletedBefore @c true if the character immediately before was deleted,
+ * @c false if the character immediately after was deleted.
*/
virtual void characterDeleted(SmartCursor* cursor, bool deletedBefore);
@@ -140,8 +140,8 @@
* One character immediately surrounding the cursor was deleted.
* If both characters are simultaneously deleted, positionDeleted() is called \
instead.
*
- * \param before true if the character immediately before was deleted, false if \
the
- * character immediately after was deleted.
+ * \param deletedBefore @c true if the character immediately before was deleted,
+ * @c false if the character immediately after was deleted.
*/
void characterDeleted(KTextEditor::SmartCursor* cursor, bool deletedBefore);
Index: interfaces/ktexteditor/smartinterface.h
===================================================================
--- interfaces/ktexteditor/smartinterface.h (revision 471795)
+++ interfaces/ktexteditor/smartinterface.h (working copy)
@@ -92,7 +92,7 @@
// BEGIN New range methods
/**
* Creates a new SmartRange.
- * \param position The initial text range assumed by the new range.
+ * \param range The initial text range assumed by the new range.
* \param parent The parent SmartRange, if this is to be the child of an \
existing range.
* \param insertBehaviour Define whether the range should expand when text is \
inserted at ends of the range.
*/
Index: interfaces/ktexteditor/codecompletioninterface.h
===================================================================
--- interfaces/ktexteditor/codecompletioninterface.h (revision 471795)
+++ interfaces/ktexteditor/codecompletioninterface.h (working copy)
@@ -400,7 +400,7 @@
* data, i.e. for empty lists.
*
* @param view the view that wants to show a completion box
- * @param completionData the completion type
+ * @param completionType the completion type
* @param insertionPosition the start position of the inserted text
* @param insertedText the inserted text
* @param currentPos the current cursor position
Index: kate/part/kateautoindent.h
===================================================================
--- kate/part/kateautoindent.h (revision 471795)
+++ kate/part/kateautoindent.h (working copy)
@@ -50,7 +50,6 @@
/**
* Standard constructor
* @param parent parent widget
- * @param name name
*/
IndenterConfigPage ( QWidget *parent=0 ) : QWidget(parent) {}
virtual ~IndenterConfigPage () {}
Index: kio/bookmarks/kbookmarkbar.h
===================================================================
--- kio/bookmarks/kbookmarkbar.h (revision 471795)
+++ kio/bookmarks/kbookmarkbar.h (working copy)
@@ -55,7 +55,6 @@
* The KActionCollection pointer argument is now obsolete.
*
* @param parent the parent widget for the bookmark toolbar
- * @param name the internal name for the bookmark toolbar
*/
KBookmarkBar( KBookmarkManager* manager,
KBookmarkOwner *owner, KToolBar *toolBar,
Index: kio/kfile/kpreviewwidgetbase.h
===================================================================
--- kio/kfile/kpreviewwidgetbase.h (revision 471795)
+++ kio/kfile/kpreviewwidgetbase.h (working copy)
@@ -52,7 +52,6 @@
* the parent.
*
* @param parent The KFileDialog this preview widget is going to be used in
- * @param name The internal name of this object
*/
KPreviewWidgetBase(QWidget *parent);
~KPreviewWidgetBase();
Index: kio/kio/kacl.h
===================================================================
--- kio/kio/kacl.h (revision 471795)
+++ kio/kio/kacl.h (working copy)
@@ -127,7 +127,7 @@
/**
* Return the entry for the permissions mask if there is one and sets
- * @param exists to true. If there is no such entry, @param is set to false.
+ * @p exists to true. If there is no such entry, @p exists is set to false.
* @return the permissions mask entry */
unsigned short maskPermissions( bool &exists ) const;
@@ -142,7 +142,7 @@
* exists. @param exists is set to true if a matching entry exists and
* to false otherwise.
* @return the permissions for a user entry with the name in @p name */
- unsigned short namedUserPermissions( const QString& name, bool *exits ) const;
+ unsigned short namedUserPermissions( const QString& name, bool *exists ) const;
/** Set the permissions for a user with the name @p name. Will fail
* if the user doesn't exist, in which case the ACL will be unchanged.
* @return success or failure. */
Index: kio/kio/kscan.h
===================================================================
--- kio/kio/kscan.h (revision 471795)
+++ kio/kio/kscan.h (working copy)
@@ -199,7 +199,6 @@
/**
* Creates a new KScanDialogFactory.
* @param parent the QWidget's parent, or 0
- * @param name the name of the QObject, can be 0
*/
KScanDialogFactory( QObject *parent=0 );
@@ -261,7 +260,6 @@
* @param buttonMask a ORed mask of all buttons (see
* KDialogBase::ButtonCode)
* @param parent the QWidget's parent, or 0
- * @param name the name of the QObject, can be 0
* @param modal if true the dialog is model
*/
KOCRDialog( int dialogFace=Tabbed, int buttonMask = Close|Help,
@@ -324,7 +322,6 @@
* Your library should reimplement this method to return your KOCRDialog
* derived dialog.
* @param parent the QWidget's parent, or 0
- * @param name the name of the QObject, can be 0
* @param modal if true the dialog is model
*/
virtual KOCRDialog * createDialog( QWidget *parent=0,
@@ -334,7 +331,6 @@
/**
* Creates a new KScanDialogFactory.
* @param parent the QWidget's parent, or 0
- * @param name the name of the QObject, can be 0
*/
KOCRDialogFactory( QObject *parent=0 );
Index: kabc/kab/qconfigDB.h
===================================================================
--- kabc/kab/qconfigDB.h (revision 471795)
+++ kabc/kab/qconfigDB.h (working copy)
@@ -197,7 +197,7 @@
bool save(QTextStream& file, int count);
/**
* Get the value for the key as a string.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString& key, Q3CString& value) const;
@@ -224,7 +224,7 @@
// ---------------
/**
* Get the value for the key as a long integer.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, long&) const;
@@ -241,7 +241,7 @@
* This will probably be not fast, but this methods are not suited to save
* large amounts of data. For saving anything else than UNICODE strings,
* no such conversion is needed.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, QString&) const;
@@ -254,7 +254,7 @@
// ---------------
/**
* Get the value for the key as a double.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, double&) const;
@@ -267,7 +267,7 @@
// ---------------
/**
* Get the value for the key as a boolean value.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, bool&) const;
@@ -280,7 +280,7 @@
// ---------------
/**
* Get the value for the key as a list of strings.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, list<Q3CString>&) const;
@@ -293,7 +293,7 @@
// --------------
/**
* Get the value for the key as a QStrList.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, Q3StrList&) const;
@@ -308,7 +308,7 @@
* Get the value for the key as a QStringList. Beware of the difference -
* a QStringList is a list of QString objects, while QStrList handles
* char* like objects.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, QStringList&) const;
@@ -321,7 +321,7 @@
// --------------
/**
* Get the value for the key as a list of long integers.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, list<long>&) const;
@@ -334,7 +334,7 @@
// --------------
/**
* Get the value for the key as a list of integers.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, list<int>&) const;
@@ -368,7 +368,7 @@
// --------------
/**
* Get the value for the key as a list of doubles.
- * \a key is the key to search for, \value is a reference to the object
+ * \a key is the key to search for, \a value is a reference to the object
* the value for the key is assigned to.
*/
bool get(const Q3CString&, list<double>&) const;
@@ -610,7 +610,7 @@
/**
* Save the file.
* \a header will be the comment in the first line of the file.
- * If \a force is \tt true, a file opened read-only will be switched
+ * If \a force is \c true, a file opened read-only will be switched
* to read and write mode and back after saving.
* @see ::setFileName
*/
@@ -655,8 +655,8 @@
static const char* version() { return "2.0 $Revision$"; }
/**
* Check wether the given file is locked.
- * The method returns zero if not, a number > zero is the pid of the process
- * locking the file, a number < zero reports an error and indicates
+ * The method returns zero if not, a number \> zero is the pid of the process
+ * locking the file, a number \< zero reports an error and indicates
* that the file is locked.
*/
static int IsLocked(const QString& fn);
@@ -686,7 +686,7 @@
static void CleanLockFiles(int);
/**
* Lock the current file.
- * Locking is done by creating a file <filename>.lock.
+ * Locking is done by creating a file \<filename\>.lock.
* QConfigDB-objects will reject opening a file for reading and
* writing if a lockfile for the filename exists.
*/
Index: kabc/kab/kabapi.h
===================================================================
--- kabc/kab/kabapi.h (revision 471795)
+++ kabc/kab/kabapi.h (working copy)
@@ -164,7 +164,6 @@
* for example, nearly similar email addresses. Empty parts of the
* entry are not considered as criteria.
* @short This method delivers the closest matches to the given entry.
- * @param name The name, containing "." for abbreviations.
* @param entries Reference to a list of entries where matches are stored.
* @param max Maximum number of returned entries.
* @return NoError if an entry is found or NoEntry.
Index: kutils/ksettings/dialog.h
===================================================================
--- kutils/ksettings/dialog.h (revision 471795)
+++ kutils/ksettings/dialog.h (working copy)
@@ -141,7 +141,6 @@
* @param parent The parent is only used as the parent for the
* dialog - centering the dialog over the parent
* widget.
- * @param name name
*/
Dialog( const QStringList & components, ContentInListView
content, QWidget * parent = 0 );
Index: kdecore/kconfigbase.h
===================================================================
--- kdecore/kconfigbase.h (revision 471795)
+++ kdecore/kconfigbase.h (working copy)
@@ -2061,7 +2061,7 @@
* object you want to work with and a string indicating the _new_
* group.
*
- * @param config The KConfigBase-derived object this
+ * @param pConfig The KConfigBase-derived object this
* KConfigGroupSaver works on.
* @param group The new group that the config object should switch to.
*/
Index: kdecore/network/kserversocket.h
===================================================================
--- kdecore/network/kserversocket.h (revision 471795)
+++ kdecore/network/kserversocket.h (working copy)
@@ -117,7 +117,6 @@
* operating system.
*
* @param parent the parent QObject object
- * @param name the name of this object
*/
KServerSocket(QObject* parent = 0L);
@@ -136,7 +135,6 @@
*
* @param service the service name to listen on
* @param parent the parent QObject object
- * @param name the name of this object
*/
KServerSocket(const QString& service, QObject* parent = 0L);
@@ -156,7 +154,6 @@
* @param node the node to bind to
* @param service the service port to listen on
* @param parent the parent QObject object
- * @param name the name of this object
*/
KServerSocket(const QString& node, const QString& service,
QObject* parent = 0L);
Index: kdecore/network/kclientsocketbase.h
===================================================================
--- kdecore/network/kclientsocketbase.h (revision 471795)
+++ kdecore/network/kclientsocketbase.h (working copy)
@@ -88,7 +88,6 @@
* Default constructor.
*
* @param parent the parent QObject object
- * @param name the name of this object
*/
KClientSocketBase(QObject* parent);
Index: kdecore/network/kbufferedsocket.h
===================================================================
--- kdecore/network/kbufferedsocket.h (revision 471795)
+++ kdecore/network/kbufferedsocket.h (working copy)
@@ -65,7 +65,6 @@
* @param node destination host
* @param service destination service to connect to
* @param parent the parent object for this object
- * @param name the internal name for this object
*/
KBufferedSocket(const QString& node = QString(), const QString& service = \
QString(), QObject* parent = 0L);
Index: kdecore/klibloader.h
===================================================================
--- kdecore/klibloader.h (revision 471795)
+++ kdecore/klibloader.h (working copy)
@@ -171,7 +171,6 @@
/**
* Create a new factory.
* @param parent the parent of the QObject, 0 for no parent
- * @param name the name of the QObject, 0 for no name
*/
KLibFactory( QObject* parent = 0 );
virtual ~KLibFactory();
@@ -208,8 +207,8 @@
* MyPlugin *plugin = factory->create<MyPlugin>( factory, parent );
* \endcode
*
- * @param parent The parent object (see QObject constructor)
- * @param name The name of the object to create (see QObject constructor)
+ * @param pParent The parent object (see QObject constructor)
+ * @param pName The name of the object to create (see QObject constructor)
* @param args A list of string arguments, passed to the factory and possibly
* to the component (see KLibFactory)
* @return A pointer to the newly created object or a null pointer if the
Index: kdecore/kauthorized.h
===================================================================
--- kdecore/kauthorized.h (revision 471795)
+++ kdecore/kauthorized.h (working copy)
@@ -72,7 +72,7 @@
* otherwise be subject to KIOSK restrictions.
* @param action The name of the action.
* @param baseURL The url where the action originates from
- * @param destURL The object of the action
+ * @param _destURL The object of the action
* @since 3.2
*/
static void allowURLAction(const QString& action, const KURL& baseURL, const KURL& \
_destURL);
Index: kparts/partmanager.h
===================================================================
--- kparts/partmanager.h (revision 471795)
+++ kparts/partmanager.h (working copy)
@@ -72,7 +72,6 @@
* @param parent The toplevel widget (window / dialog) the
* partmanager should monitor for activation/selection
* events
- * @param name The object's name, if any.
*/
PartManager( QWidget * parent );
/**
@@ -82,7 +81,6 @@
* partmanager should monitor for activation/selection
* events
* @param parent The parent QObject.
- * @param name The object's name, if any.
*/
PartManager( QWidget * topLevel, QObject *parent );
virtual ~PartManager();
Index: kdeui/kaboutdialog.h
===================================================================
--- kdeui/kaboutdialog.h (revision 471795)
+++ kdeui/kaboutdialog.h (working copy)
@@ -328,7 +328,6 @@
* @param buttonMask Specifies what buttons will be visible.
* @param defaultButton Specifies what button will be marked as the default.
* @param parent Parent of the dialog.
- * @param name Dialog name (for internal use only)
* @param modal Sets dialog modality. If false, the rest of the
* program interface (other dialogs, for example) is accessible while
* the dialog is open.
Index: kdeui/ktoolbarbutton.h
===================================================================
--- kdeui/ktoolbarbutton.h (revision 471795)
+++ kdeui/ktoolbarbutton.h (working copy)
@@ -81,7 +81,6 @@
* Construct a separator button
*
* @param parent This button's parent
- * @param name This button's internal name
*/
KToolBarButton(QWidget *parent=0L);
Index: kdeui/krestrictedline.h
===================================================================
--- kdeui/krestrictedline.h (revision 471795)
+++ kdeui/krestrictedline.h (working copy)
@@ -52,7 +52,6 @@
* Constructor: This contructor takes three - optional - arguments.
* The first two parameters are simply passed on to QLineEdit.
* @param parent pointer to the parent widget
- * @param name pointer to the name of this widget
*/
KRestrictedLine( QWidget* parent );
Index: kdeui/kurllabel.h
===================================================================
--- kdeui/kurllabel.h (revision 471795)
+++ kdeui/kurllabel.h (working copy)
@@ -88,7 +88,6 @@
* @param text is the displayed string. If it's equal to QString::null
* the @p url will be used instead.
* @param parent Passed to lower level constructor
- * @param name Passed to lower level constructor
*
* @p parent and @p name are passed to QLabel, which in turn passes
* them further down
Index: kdeui/kled.h
===================================================================
--- kdeui/kled.h (revision 471795)
+++ kdeui/kled.h (working copy)
@@ -97,7 +97,6 @@
*
* @param col Initial color of the LED.
* @param parent Will be handed over to QWidget.
- * @param name Will be handed over to QWidget.
* @short Constructor
*/
KLed(const QColor &col, QWidget *parent=0);
@@ -113,7 +112,6 @@
* @param look Sets the Look.
* @param shape Sets the Shape (rectangular or circular)
* @param parent Will be handed over to QWidget.
- * @param name Will be handed over to QWidget.
* @short Constructor
*/
KLed(const QColor& col, KLed::State state, KLed::Look look, KLed::Shape shape,
Index: kdeui/kedittoolbar.h
===================================================================
--- kdeui/kedittoolbar.h (revision 471795)
+++ kdeui/kedittoolbar.h (working copy)
@@ -138,7 +138,6 @@
* @param global If @p true, then the global resource file will also
* be parsed.
* @param parent The parent of the dialog.
- * @param name An internal name.
*/
KEditToolbar(KActionCollection *collection,
const QString& xmlfile = QString::null, bool global = true,
@@ -176,7 +175,6 @@
*
* @param factory Your application's factory object
* @param parent The usual parent for the dialog.
- * @param name An internal name.
*
* Some people seem tempted to use this also in non-KParts apps, using \
KMainWindow::guiFactory().
* This works, but only _if_ setting conserveMemory to false when calling
Index: kdeui/ksconfig.h
===================================================================
--- kdeui/ksconfig.h (revision 471795)
+++ kdeui/ksconfig.h (working copy)
@@ -93,7 +93,6 @@
* Constructs a KSpellConfig with default or custom settings.
*
* @param parent Parent of the widget.
- * @param name Widget name.
* @param spellConfig Predefined configuration. If this parameter
* is 0, a default configuration will be used.
* @param addHelpButton Enabled or hides a help button. See
Index: kdeui/kmenu.h
===================================================================
--- kdeui/kmenu.h (revision 471795)
+++ kdeui/kmenu.h (working copy)
@@ -54,6 +54,7 @@
* Constructs a KMenu.
* \param title The text displayed in a parent menu when it is inserted
* into another menu as a submenu.
+ * \param parent the parent QWidget object
*/
KMenu(const QString& title, QWidget *parent = 0L);
>> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to unsubscribe <<
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic