diff --git a/abstractrunner.h b/abstractrunner.h index aabc80522..7e336d4ea 100644 --- a/abstractrunner.h +++ b/abstractrunner.h @@ -141,7 +141,7 @@ class PLASMA_EXPORT AbstractRunner : public QObject /** * Triggers a call to match. This will call match() internally. * - * @arg context the search context used in executing this match. + * @param context the search context used in executing this match. */ void performMatch(Plasma::RunnerContext &context); @@ -337,8 +337,8 @@ class PLASMA_EXPORT AbstractRunner : public QObject * a measure of safety for runners running their own threads. This should * be used instead of calling KServiceTypeTrader::query(..) directly. * - * @arg serviceType a service type like "Plasma/Applet" or "KFilePlugin" - * @arg constraint a constraint to limit the choices returned. + * @param serviceType a service type like "Plasma/Applet" or "KFilePlugin" + * @param constraint a constraint to limit the choices returned. * @see KServiceTypeTrader::query(const QString&, const QString&) * * @return a list of services that satisfy the query. diff --git a/animations/animation.h b/animations/animation.h index dae4a0d9d..00e8ad0aa 100644 --- a/animations/animation.h +++ b/animations/animation.h @@ -102,7 +102,7 @@ public: /** * Set the widget on which the animation is to be performed. - * @arg widget The QGraphicsWidget to be animated. + * @param widget The QGraphicsWidget to be animated. */ void setTargetWidget(QGraphicsWidget* widget); @@ -124,7 +124,7 @@ public: protected: /** * Change the animation duration. Default is 250ms. - * @arg duration The new duration of the animation. + * @param duration The new duration of the animation. */ virtual void setDuration(int duration = 250); diff --git a/animations/geometry_p.h b/animations/geometry_p.h index 47f40068d..52a405b84 100644 --- a/animations/geometry_p.h +++ b/animations/geometry_p.h @@ -62,7 +62,7 @@ public: * * If no geometry is set, it will use the widget current geometry * when the animation is first run). - * @arg geometry The initial geometry. + * @param geometry The initial geometry. */ void setStartGeometry(const QRectF &geometry); diff --git a/animations/rotation_p.h b/animations/rotation_p.h index 2d898a357..30d3d7930 100644 --- a/animations/rotation_p.h +++ b/animations/rotation_p.h @@ -80,27 +80,27 @@ public: /** * Reimplemented from Plasma::Animation - * @arg curve Easing curve + * @param curve Easing curve */ void setEasingCurve(const QEasingCurve &curve); public slots: /** * set animation rotation axis - * @arg axis Rotation (e.g. YAxis, ZAxis, XAxis) + * @param axis Rotation (e.g. YAxis, ZAxis, XAxis) */ void setAxis(const Qt::Axis &axis); /** * Set rotation reference (e.g. Center, Up, Down, Left, Right) can * be combined (i.e. Center|Up) - * @arg reference The reference + * @param reference The reference */ void setReference(const qint8 &reference); /** * Set animation rotation angle (e.g. 45, 180, etc) - * @arg angle The angle + * @param angle The angle */ void setAngle(const qreal &angle); diff --git a/animations/rotationstacked_p.h b/animations/rotationstacked_p.h index 6771b8f49..9ebefde75 100644 --- a/animations/rotationstacked_p.h +++ b/animations/rotationstacked_p.h @@ -57,7 +57,7 @@ public: /** * Set the animation movement direction (e.g. MoveAny, MoveUp, MoveDown, * MoveLeft, MoveRight) which can be combined (i.e. MoveUp|MoveLeft). - * @arg direction animation direction + * @param direction animation direction */ void setMovementDirection(const Animation::MovementDirection &direction); @@ -69,7 +69,7 @@ public: /** * Set the animation rotation reference (e.g. Center, Up, Down, Left, * Right) which can be combined (i.e. Center|Up). - * @arg reference animation reference + * @param reference animation reference */ void setReference(const Animation::Reference &reference); @@ -91,7 +91,7 @@ public: /** * Set the back widget that is used after the animation to be finished - * @arg backWidget The back widget + * @param backWidget The back widget */ void setBackWidget(QGraphicsWidget *backWidget); diff --git a/animations/slide_p.h b/animations/slide_p.h index 3e4ab39f2..23952613d 100644 --- a/animations/slide_p.h +++ b/animations/slide_p.h @@ -66,7 +66,7 @@ public: /** * Set the animation direction - * @arg direction animation direction + * @param direction animation direction */ void setMovementDirection(const Animation::MovementDirection&direction); diff --git a/animator.h b/animator.h index 797c05e04..32ed24c9a 100644 --- a/animator.h +++ b/animator.h @@ -115,8 +115,8 @@ public: /** * Starts a standard animation on a QGraphicsItem. * - * @arg item the item to animate in some fashion - * @arg anim the type of animation to perform + * @param item the item to animate in some fashion + * @param anim the type of animation to perform * @return the id of the animation * @deprecated use new Animator API with Qt Kinetic **/ @@ -129,7 +129,7 @@ public: * Note that it is not necessary to call * this on normal completion of the animation. * - * @arg id the id of the animation as returned by animateItem + * @param id the id of the animation as returned by animateItem * @deprecated use new Animator API with Qt Kinetic */ #ifndef KDE_NO_DEPRECATED @@ -139,8 +139,8 @@ public: /** * Starts a standard animation on a QGraphicsItem. * - * @arg item the item to animate in some fashion - * @arg anim the type of animation to perform + * @param item the item to animate in some fashion + * @param anim the type of animation to perform * @return the id of the animation * @deprecated use new Animator API with Qt Kinetic **/ @@ -153,7 +153,7 @@ public: * Note that it is not necessary to call * this on normal completion of the animation. * - * @arg id the id of the animation as returned by moveItem + * @param id the id of the animation as returned by moveItem * @deprecated use new Animator API with Qt Kinetic */ #ifndef KDE_NO_DEPRECATED @@ -164,11 +164,11 @@ public: * Starts a custom animation, preventing the need to create a timeline * with its own timer tick. * - * @arg frames the number of frames this animation should persist for - * @arg duration the length, in milliseconds, the animation will take - * @arg curve the curve applied to the frame rate - * @arg receive the object that will handle the actual animation - * @arg method the method name of slot to be invoked on each update. + * @param frames the number of frames this animation should persist for + * @param duration the length, in milliseconds, the animation will take + * @param curve the curve applied to the frame rate + * @param receive the object that will handle the actual animation + * @param method the method name of slot to be invoked on each update. * It must take a qreal. So if the slot is animate(qreal), * pass in "animate" as the method parameter. * It has an optional integer paramenter that takes an @@ -188,7 +188,7 @@ public: * this on object destruction, as custom animations associated with * a given QObject are cleaned up automatically on QObject destruction. * - * @arg id the id of the animation as returned by customAnimation + * @param id the id of the animation as returned by customAnimation * @deprecated use new Animator API with Qt Kinetic */ #ifndef KDE_NO_DEPRECATED diff --git a/applet.h b/applet.h index a417dfddb..96767520f 100644 --- a/applet.h +++ b/applet.h @@ -337,7 +337,7 @@ class PLASMA_EXPORT Applet : public QGraphicsWidget /** * Sets the list of custom categories that are used in addition to the default * set of categories known to libplasma for Applets. - * @arg categories a list of categories + * @param categories a list of categories * @since 4.3 */ void setCustomCategories(const QStringList &categories); @@ -804,7 +804,7 @@ class PLASMA_EXPORT Applet : public QGraphicsWidget /** * Sets the immutability type for this applet (not immutable, * user immutable or system immutable) - * @arg immutable the new immutability type of this applet + * @param immutable the new immutability type of this applet */ void setImmutability(const ImmutabilityType immutable); @@ -833,7 +833,7 @@ class PLASMA_EXPORT Applet : public QGraphicsWidget * Actually show your custom configuration interface * Use this only if you reimplemented showConfigurationInterface() * - * @arg widget the widget representing your configuration interface + * @param widget the widget representing your configuration interface * * @since 4.5 */ diff --git a/configloader.h b/configloader.h index 4ae0ef0f8..26334e0f6 100644 --- a/configloader.h +++ b/configloader.h @@ -109,8 +109,8 @@ public: /** * Finds the item for the given group and key. * - * @arg group the group in the config file to look in - * @arg key the configuration key to find + * @param group the group in the config file to look in + * @param key the configuration key to find * @return the associated KConfigSkeletonItem, or 0 if none */ KConfigSkeletonItem *findItem(const QString &group, const QString &key); diff --git a/containment.h b/containment.h index c60eda01c..a6ebcddaa 100644 --- a/containment.h +++ b/containment.h @@ -303,7 +303,7 @@ class PLASMA_EXPORT Containment : public Applet /** * Sets the open or closed state of the Containment's toolbox * - * @arg open true to open the ToolBox, false to close it + * @param open true to open the ToolBox, false to close it */ void setToolBoxOpen(bool open); @@ -523,7 +523,7 @@ Q_SIGNALS: * it will be removed nicely and deleted. * Its configuration will also be deleted. * - * @arg confirm whether or not confirmation from the user should be requested + * @param confirm whether or not confirmation from the user should be requested */ void destroy(bool confirm); diff --git a/containmentactions.h b/containmentactions.h index 5ab4570f0..57239c3dc 100644 --- a/containmentactions.h +++ b/containmentactions.h @@ -204,8 +204,8 @@ class PLASMA_EXPORT ContainmentActions : public QObject /** * Returns a popup position appropriate to the event and the size. * - * @arg s size of the popup - * @arg event a pointer to the event that triggered the popup + * @param s size of the popup + * @param event a pointer to the event that triggered the popup * @return the preferred top-left position for the popup * @since 4.6 */ diff --git a/corona.h b/corona.h index 4104ff618..3e7b0f311 100644 --- a/corona.h +++ b/corona.h @@ -340,7 +340,7 @@ public Q_SLOTS: /** * Save applets layout to file - * @arg config the file to save to, or the default config file if QString() + * @param config the file to save to, or the default config file if QString() */ void saveLayout(const QString &config = QString()) const; @@ -352,7 +352,7 @@ public Q_SLOTS: /** * Sets the immutability type for this Corona (not immutable, * user immutable or system immutable) - * @arg immutable the new immutability type of this applet + * @param immutable the new immutability type of this applet */ void setImmutability(const ImmutabilityType immutable); @@ -462,8 +462,8 @@ protected: /** * Maps a stock animation to one of the semantic animations. Used to control things such * as what animation is used to make a Plasma::Appear appear in a containment. - * @arg from the animation to map a new value to - * @arg to the animation value to map to from + * @param from the animation to map a new value to + * @param to the animation value to map to from * @since 4.5 */ void mapAnimation(Animator::Animation from, Animator::Animation to); @@ -471,8 +471,8 @@ protected: /** * Maps a loadable animation to one of the semantic animations. Used to control things such * as what animation is used to make a Plasma::Appear appear in a containment. - * @arg from the animation to map a new value to - * @arg to the animation value to map to from; this must map to a Javascript animation + * @param from the animation to map a new value to + * @param to the animation value to map to from; this must map to a Javascript animation * @since 4.5 */ void mapAnimation(Animator::Animation from, const QString &to); diff --git a/dialog.h b/dialog.h index 4c4ef12a2..a8a53f7ca 100644 --- a/dialog.h +++ b/dialog.h @@ -66,8 +66,8 @@ class PLASMA_EXPORT Dialog : public QWidget Q_DECLARE_FLAGS(ResizeCorners, ResizeCorner) /** - * @arg parent the parent widget, for plasmoids, this is usually 0. - * @arg f the Qt::WindowFlags, default is to not show a windowborder. + * @param parent the parent widget, for plasmoids, this is usually 0. + * @param f the Qt::WindowFlags, default is to not show a windowborder. */ explicit Dialog(QWidget * parent = 0, Qt::WindowFlags f = Qt::Window); virtual ~Dialog(); @@ -77,7 +77,7 @@ class PLASMA_EXPORT Dialog : public QWidget * The dialog will then set up a QGraphicsView and coordinate geometry with * the widget automatically. * - * @arg widget the QGraphicsWidget to display in this dialog + * @param widget the QGraphicsWidget to display in this dialog */ void setGraphicsWidget(QGraphicsWidget *widget); @@ -87,7 +87,7 @@ class PLASMA_EXPORT Dialog : public QWidget QGraphicsWidget *graphicsWidget(); /** - * @arg corners the corners the resize handlers should be placed in. + * @param corners the corners the resize handlers should be placed in. */ void setResizeHandleCorners(ResizeCorners corners); diff --git a/framesvg.h b/framesvg.h index d43e2535e..ebf001a44 100644 --- a/framesvg.h +++ b/framesvg.h @@ -99,7 +99,7 @@ class PLASMA_EXPORT FrameSvg : public Svg * as borders. It may also be used as a regular Plasma::Svg object * for direct access to elements in the Svg. * - * @arg parent options QObject to parent this to + * @param parent options QObject to parent this to * * @related Plasma::Theme */ @@ -108,13 +108,13 @@ class PLASMA_EXPORT FrameSvg : public Svg /** * Loads a new Svg - * @arg imagePath the new file + * @param imagePath the new file */ Q_INVOKABLE void setImagePath(const QString &path); /** * Sets what borders should be painted - * @arg flags borders we want to paint + * @param flags borders we want to paint */ void setEnabledBorders(const EnabledBorders borders); @@ -126,7 +126,7 @@ class PLASMA_EXPORT FrameSvg : public Svg /** * Resize the frame maintaining the same border size - * @arg size the new size of the frame + * @param size the new size of the frame */ Q_INVOKABLE void resizeFrame(const QSizeF &size); @@ -137,7 +137,7 @@ class PLASMA_EXPORT FrameSvg : public Svg /** * Returns the margin size given the margin edge we want - * @arg edge the margin edge we want, top, bottom, left or right + * @param edge the margin edge we want, top, bottom, left or right * @return the margin size */ Q_INVOKABLE qreal marginSize(const Plasma::MarginEdge edge) const; @@ -145,10 +145,10 @@ class PLASMA_EXPORT FrameSvg : public Svg /** * Convenience method that extracts the size of the four margins * in the four output parameters - * @arg left left margin size - * @arg top top margin size - * @arg right right margin size - * @arg bottom bottom margin size + * @param left left margin size + * @param top top margin size + * @param right right margin size + * @param bottom bottom margin size */ Q_INVOKABLE void getMargins(qreal &left, qreal &top, qreal &right, qreal &bottom) const; @@ -164,7 +164,7 @@ class PLASMA_EXPORT FrameSvg : public Svg * * The prefix must exist in the SVG document, which means that this can only be * called successfully after setImagePath is called. - * @arg location location in the UI this frame will be drawn + * @param location location in the UI this frame will be drawn */ Q_INVOKABLE void setElementPrefix(Plasma::Location location); @@ -182,14 +182,14 @@ class PLASMA_EXPORT FrameSvg : public Svg * The prefix must exist in the SVG document, which means that this can only be * called successfully after setImagePath is called. * - * @arg prefix prefix for the SVG elements that make up the frame + * @param prefix prefix for the SVG elements that make up the frame */ Q_INVOKABLE void setElementPrefix(const QString & prefix); /** * @return true if the svg has the necessary elements with the given prefix * to draw a frame - * @arg prefix the given prefix we want to check if drawable + * @param prefix the given prefix we want to check if drawable */ Q_INVOKABLE bool hasElementPrefix(const QString & prefix) const; @@ -199,7 +199,7 @@ class PLASMA_EXPORT FrameSvg : public Svg * hasElementPrefix("west") and hasElementPrefix("east") * @return true if the svg has the necessary elements with the given prefix * to draw a frame. - * @arg location the given prefix we want to check if drawable + * @param location the given prefix we want to check if drawable */ Q_INVOKABLE bool hasElementPrefix(Plasma::Location location) const; @@ -222,7 +222,7 @@ class PLASMA_EXPORT FrameSvg : public Svg /** * Sets whether saving all the rendered prefixes in a cache or not - * @arg cache if use the cache or not + * @param cache if use the cache or not */ Q_INVOKABLE void setCacheAllRenderedFrames(bool cache); @@ -241,7 +241,7 @@ class PLASMA_EXPORT FrameSvg : public Svg /** * Returns a pixmap of the SVG represented by this object. * - * @arg elelementId the ID string of the element to render, or an empty + * @param elelementId the ID string of the element to render, or an empty * string for the whole SVG (the default) * @return a QPixmap of the rendered SVG */ @@ -249,9 +249,9 @@ class PLASMA_EXPORT FrameSvg : public Svg /** * Paints the loaded SVG with the elements that represents the border - * @arg painter the QPainter to use - * @arg target the target rectangle on the paint device - * @arg source the portion rectangle of the source image + * @param painter the QPainter to use + * @param target the target rectangle on the paint device + * @param source the portion rectangle of the source image */ Q_INVOKABLE void paintFrame(QPainter *painter, const QRectF &target, const QRectF &source = QRectF()); @@ -259,8 +259,8 @@ class PLASMA_EXPORT FrameSvg : public Svg /** * Paints the loaded SVG with the elements that represents the border * This is an overloaded member provided for convenience - * @arg painter the QPainter to use - * @arg pos where to paint the svg + * @param painter the QPainter to use + * @param pos where to paint the svg */ Q_INVOKABLE void paintFrame(QPainter *painter, const QPointF &pos = QPointF(0, 0)); diff --git a/glapplet.h b/glapplet.h index f264bd3e8..66568e71d 100644 --- a/glapplet.h +++ b/glapplet.h @@ -40,10 +40,10 @@ class PLASMA_EXPORT_DEPRECATED GLApplet : public Applet public: /** - * @arg parent the QGraphicsItem this applet is parented to - * @arg serviceId the name of the .desktop file containing the + * @param parent the QGraphicsItem this applet is parented to + * @param serviceId the name of the .desktop file containing the * information about the widget - * @arg appletId a unique id used to differentiate between multiple + * @param appletId a unique id used to differentiate between multiple * instances of the same Applet type */ GLApplet(QGraphicsItem *parent, @@ -56,8 +56,8 @@ class PLASMA_EXPORT_DEPRECATED GLApplet : public Applet * to have two elements: the KService service ID for the desktop entry * and an applet ID which must be a base 10 number. * - * @arg parent a QObject parent; you probably want to pass in 0 - * @arg args a list of strings containing two entries: the service id + * @param parent a QObject parent; you probably want to pass in 0 + * @param args a list of strings containing two entries: the service id * and the applet id */ GLApplet(QObject *parent, const QVariantList &args); diff --git a/package.h b/package.h index 15b22ddd3..7e4995bcb 100644 --- a/package.h +++ b/package.h @@ -51,9 +51,9 @@ class PLASMA_EXPORT Package /** * Construct a Package object * - * @arg packageRoot path to the package installation root - * @arg package the name of the package - * @arg structure the package structure describing this package + * @param packageRoot path to the package installation root + * @param package the name of the package + * @param structure the package structure describing this package **/ Package(const QString &packageRoot, const QString &package, PackageStructure::Ptr structure); @@ -61,8 +61,8 @@ class PLASMA_EXPORT Package /** * Construct a Package object. * - * @arg packagePath full path to the package directory - * @arg structure the package structure describing this package + * @param packagePath full path to the package directory + * @param structure the package structure describing this package */ Package(const QString &packagePath, PackageStructure::Ptr structure); @@ -89,9 +89,9 @@ class PLASMA_EXPORT Package /** * Get the path to a given file. * - * @arg fileType the type of file to look for, as defined in the + * @param fileType the type of file to look for, as defined in the * package structure - * @arg filename the name of the file + * @param filename the name of the file * @return path to the file on disk. QString() if not found. **/ QString filePath(const char *fileType, const QString &filename) const; @@ -99,7 +99,7 @@ class PLASMA_EXPORT Package /** * Get the path to a given file. * - * @arg fileType the type of file to look for, as defined in the + * @param fileType the type of file to look for, as defined in the * package structure. The type must refer to a file * in the package structure and not a directory. * @return path to the file on disk. QString() if not found @@ -109,7 +109,7 @@ class PLASMA_EXPORT Package /** * Get the list of files of a given type. * - * @arg fileType the type of file to look for, as defined in the + * @param fileType the type of file to look for, as defined in the * package structure. * @return list of files by name, suitable for passing to filePath **/ @@ -122,7 +122,7 @@ class PLASMA_EXPORT Package /** * Sets the path to the root of this package - * @arg path and absolute path + * @param path and absolute path * @since 4.3 */ void setPath(const QString &path); @@ -210,7 +210,7 @@ class PLASMA_EXPORT Package /** * Registers a package described by the given desktop file * - * @arg the full path to the desktop file (must be KPluginInfo compatible) + * @param the full path to the desktop file (must be KPluginInfo compatible) * @return true on success, false on failure */ static bool registerPackage(const PackageMetadata &data, const QString &iconPath); @@ -219,11 +219,11 @@ class PLASMA_EXPORT Package * Creates a package based on the metadata from the files contained * in the source directory * - * @arg metadata description of the package to create - * @arg source path to local directory containing the individual + * @param metadata description of the package to create + * @param source path to local directory containing the individual * files to be added to the package - * @arg destination path to the package that should be created - * @arg icon path to the package icon + * @param destination path to the package that should be created + * @param icon path to the package icon **/ static bool createPackage(const PackageMetadata &metadata, const QString &source, diff --git a/packagemetadata.h b/packagemetadata.h index 5fa72e933..b10f0e4f1 100644 --- a/packagemetadata.h +++ b/packagemetadata.h @@ -63,7 +63,7 @@ public: * with KPluginInfo * @see KPluginInfo * - * @arg filename path to the file to write to + * @param filename path to the file to write to **/ void write(const QString &filename) const; @@ -73,7 +73,7 @@ public: * with KPluginInfo * @see KPluginInfo * - * @arg filename path to the file to write to + * @param filename path to the file to write to **/ void read(const QString &filename); diff --git a/packagestructure.h b/packagestructure.h index b2f2e4387..228c8168d 100644 --- a/packagestructure.h +++ b/packagestructure.h @@ -79,7 +79,7 @@ public: /** * Default constructor for a package structure definition * - * @arg type the type of package. This is often application specific. + * @param type the type of package. This is often application specific. **/ explicit PackageStructure(QObject *parent = 0, const QString &type = i18nc("A non-functional package", "Invalid")); @@ -97,7 +97,7 @@ public: /** * Loads a package format by name. * - * @arg format If not empty, attempts to locate the given format, either + * @param format If not empty, attempts to locate the given format, either * from built-ins or via plugins. * @return a package that matches the format, if available. The caller * is responsible for deleting the object. @@ -179,7 +179,7 @@ public: /** * Get the list of files of a given type. * - * @arg key the type of file to look for + * @param key the type of file to look for * @return list of files by name * @since 4.3 */ @@ -264,8 +264,8 @@ public: /** * Uninstalls a package matching this package structure. * - * @arg packageName the name of the package to remove - * @arg packageRoot path to the directory where the package should be installed to + * @param packageName the name of the package to remove + * @param packageRoot path to the directory where the package should be installed to * @return true on successful removal of the package, false otherwise */ virtual bool uninstallPackage(const QString &packageName, const QString &packageRoot); @@ -332,7 +332,7 @@ Q_SIGNALS: protected: /** * Sets whether or not external paths/symlinks can be followed by a package - * @arg allow true if paths/symlinks outside of the package should be followed, + * @param allow true if paths/symlinks outside of the package should be followed, * false if they should be rejected. */ void setAllowExternalPaths(bool allow); @@ -343,7 +343,7 @@ protected: * between the base path and the entries as defined by the package * structure * - * @arg prefix the directory prefix to use + * @param prefix the directory prefix to use * @deprecated use setContentsPrefixPaths() instead. */ KDE_DEPRECATED void setContentsPrefix(const QString &prefix); @@ -356,7 +356,7 @@ protected: * In this case each file request will be searched in all prefixes in order, * and the first found will be returned. * - * @arg prefix paths the directory prefix to use + * @param prefix paths the directory prefix to use * @since 4.6 */ void setContentsPrefixPaths(const QStringList &prefixPaths); diff --git a/plasma.h b/plasma.h index 5ed89816c..d6b9f8bd3 100644 --- a/plasma.h +++ b/plasma.h @@ -308,7 +308,7 @@ PLASMA_EXPORT Direction locationToInverseDirection(Location location); /** * Returns the most appropriate QGraphicsView for the item. * - * @arg item the QGraphicsItem to locate a view for + * @param item the QGraphicsItem to locate a view for * @return pointer to a view, or 0 if none was found */ PLASMA_EXPORT QGraphicsView *viewFor(const QGraphicsItem *item); diff --git a/popupapplet.h b/popupapplet.h index cc806251b..7b8191ade 100644 --- a/popupapplet.h +++ b/popupapplet.h @@ -59,7 +59,7 @@ public: ~PopupApplet(); /** - * @arg icon the icon that has to be displayed when the applet is in a panel. + * @param icon the icon that has to be displayed when the applet is in a panel. * Passing in a null icon means that the popup applet itself * will provide an interface for when the PopupApplet is not showing * the widget() or graphicsWidget() directly. @@ -67,7 +67,7 @@ public: void setPopupIcon(const QIcon &icon); /** - * @arg icon the icon that has to be displayed when the applet is in a panel. + * @param icon the icon that has to be displayed when the applet is in a panel. * Passing in an empty QString() means that the popup applet itself * will provide an interface for when the PopupApplet is not showing * the widget() or graphicsWidget() directly. @@ -107,7 +107,7 @@ public: /** * Sets the default alignment of the popup relative to the applet - * @arg alignment the alignment to use; Qt::AlignLeft or Qt::AlignRight + * @param alignment the alignment to use; Qt::AlignLeft or Qt::AlignRight * @since 4.6 */ void setPopupAlignment(Qt::AlignmentFlag alignment); @@ -122,7 +122,7 @@ public: * Sets whether or not the dialog popup that gets created should be a "passive" popup * that does not steal focus from other windows or not. * - * @arg passive true if the dialog should be treated as a passive popup + * @param passive true if the dialog should be treated as a passive popup */ void setPassivePopup(bool passive); @@ -151,7 +151,7 @@ public Q_SLOTS: /** * Shows the dialog showing the widget if the applet is in a panel. - * @arg displayTime the time in ms that the popup should be displayed, defaults to 0 which means + * @param displayTime the time in ms that the popup should be displayed, defaults to 0 which means * always (until the user closes it again, that is). */ void showPopup(uint displayTime = 0); @@ -165,7 +165,7 @@ protected: /** * This event handler can be reimplemented in a subclass to receive an * event before the popup is shown or hidden. - * @arg show true if the popup is going to be shown, false if the popup + * @param show true if the popup is going to be shown, false if the popup * is going to be hidden. * Note that showing and hiding the popup on click is already done in PopupApplet. */ diff --git a/remote/accessappletjob.h b/remote/accessappletjob.h index b13dd9db6..0cd294b5b 100644 --- a/remote/accessappletjob.h +++ b/remote/accessappletjob.h @@ -52,8 +52,8 @@ protected: /** * Default constructor * - * @arg location the location of the service - * @arg parent the parent object for this service + * @param location the location of the service + * @param parent the parent object for this service */ AccessAppletJob(const KUrl &location, QObject *parent = 0); diff --git a/remote/serviceaccessjob.h b/remote/serviceaccessjob.h index 0225f77f6..4216313f6 100644 --- a/remote/serviceaccessjob.h +++ b/remote/serviceaccessjob.h @@ -52,8 +52,8 @@ protected: /** * Default constructor * - * @arg location the location of the service - * @arg parent the parent object for this service + * @param location the location of the service + * @param parent the parent object for this service */ ServiceAccessJob(KUrl location, QObject *parent = 0); diff --git a/runnercontext.h b/runnercontext.h index cfb956ed3..4bc7ee92b 100644 --- a/runnercontext.h +++ b/runnercontext.h @@ -146,8 +146,8 @@ class PLASMA_EXPORT RunnerContext : public QObject * * If you are going to be adding multiple matches, use addMatches instead. * - * @arg term the search term that this match was generated for. - * @arg match the match to add + * @param term the search term that this match was generated for. + * @param match the match to add * * @return true if the match was added, false otherwise. */ @@ -160,7 +160,7 @@ class PLASMA_EXPORT RunnerContext : public QObject * * If you are going to be removing multiple matches, use removeMatches instead. * - * @arg matchId the id of match to remove + * @param matchId the id of match to remove * * @return true if the match was removed, false otherwise. * @since 4.4 @@ -172,7 +172,7 @@ class PLASMA_EXPORT RunnerContext : public QObject * * This method is thread safe and causes the matchesChanged() signal to be emitted. * - * @arg matchIdList the list of matches id to remove + * @param matchIdList the list of matches id to remove * * @return true if at least one match was removed, false otherwise. * @since 4.4 diff --git a/runnermanager.h b/runnermanager.h index 341d22fe5..382f76a50 100644 --- a/runnermanager.h +++ b/runnermanager.h @@ -57,7 +57,7 @@ class PLASMA_EXPORT RunnerManager : public QObject /** * Finds and returns a loaded runner or NULL - * @arg name the name of the runner + * @param name the name of the runner * @return Pointer to the runner */ AbstractRunner *runner(const QString &name) const; @@ -73,7 +73,7 @@ class PLASMA_EXPORT RunnerManager : public QObject * runner; if the runner does not exist or can not be loaded then * the single runner mode will not be started and singleModeRunner() * will return NULL - * @arg id the id of the runner to use + * @param id the id of the runner to use * @since 4.4 */ void setSingleModeRunnerId(const QString &id); @@ -93,14 +93,14 @@ class PLASMA_EXPORT RunnerManager : public QObject /** * Sets whether or not the manager is in single mode. * - * @arg singleMode true if the manager should be in single mode, false otherwise + * @param singleMode true if the manager should be in single mode, false otherwise * @since 4.4 */ void setSingleMode(bool singleMode); /** * Returns the translated name of a runner - * @arg id the id of the runner + * @param id the id of the runner * * @since 4.4 */ @@ -131,13 +131,13 @@ class PLASMA_EXPORT RunnerManager : public QObject /** * Runs a given match - * @arg match the match to be executed + * @param match the match to be executed */ void run(const QueryMatch &match); /** * Runs a given match - * @arg id the id of the match to run + * @param id the id of the match to run */ void run(const QString &id); @@ -159,7 +159,7 @@ class PLASMA_EXPORT RunnerManager : public QObject /** * Sets a whitelist for the plugins that can be loaded * - * @arg plugins the plugin names of allowed runners + * @param plugins the plugin names of allowed runners * @since 4.4 */ void setAllowedRunners(const QStringList &runners); @@ -171,7 +171,7 @@ class PLASMA_EXPORT RunnerManager : public QObject * but in cases where specific runners should be loaded this * allows for that to take place * - * @arg service the service to use to load the plugin + * @param service the service to use to load the plugin * @since 4.5 */ void loadRunner(const KService::Ptr service); @@ -182,7 +182,7 @@ class PLASMA_EXPORT RunnerManager : public QObject * handle loading Runner plugins, but in cases where specific * runners should be loaded this allows for that to take place * - * @arg path the path to a Runner package to load + * @param path the path to a Runner package to load * @since 4.5 */ void loadRunner(const QString &path); @@ -241,8 +241,8 @@ class PLASMA_EXPORT RunnerManager : public QObject * When the information will be available can be known using the * matchesChanged signal. * - * @arg term the term we want to find matches for - * @arg runnerId optional, if only one specific runner is to be used; + * @param term the term we want to find matches for + * @param runnerId optional, if only one specific runner is to be used; * providing an id will put the manager into single runner mode */ void launchQuery(const QString &term, const QString &runnerId); @@ -257,8 +257,8 @@ class PLASMA_EXPORT RunnerManager : public QObject * This means that the method may be dangerous as it wait a variable amount * of time for the runner to finish. * The runner parameter is mandatory, to avoid launching unwanted runners. - * @arg term the term we want to find matches for - * @arg runner the runner we will use, it is mandatory + * @param term the term we want to find matches for + * @param runner the runner we will use, it is mandatory * @return 0 if nothing was launched, 1 if launched. */ bool execQuery(const QString &term, const QString &runnerName); diff --git a/runnersyntax.h b/runnersyntax.h index 690a734ec..63a2624a8 100644 --- a/runnersyntax.h +++ b/runnersyntax.h @@ -43,11 +43,11 @@ class PLASMA_EXPORT RunnerSyntax /** * Constructs a simple syntax object * - * @arg exampleQuery an example of the query, with :q: placed wherever + * @param exampleQuery an example of the query, with :q: placed wherever * search term text might appear. e.g. if the runner * accepts "keyword some random text" then the value * of this parameter should be "keyword :q:" - * @arg descrition A description of what the described syntax does from + * @param descrition A description of what the described syntax does from * the user's point of view. */ RunnerSyntax(const QString &exampleQuery, const QString &description); @@ -70,7 +70,7 @@ class PLASMA_EXPORT RunnerSyntax * This allows the runner to show these relationships by grouping the * example queries into one Syntax object * - * @arg exampleQuery an example of the query, with :q: placed wherever + * @param exampleQuery an example of the query, with :q: placed wherever * search term text might appear. e.g. if the runner * accepts "keyword some random text" then the value * of this parameter should be "keyword :q:" diff --git a/scripting/appletscript.h b/scripting/appletscript.h index 424690ce4..9d1c78b84 100644 --- a/scripting/appletscript.h +++ b/scripting/appletscript.h @@ -120,7 +120,7 @@ public: /** * Sets whether or not this script has a configuration interface or not * - * @arg hasInterface true if the applet is user configurable + * @param hasInterface true if the applet is user configurable */ void setHasConfigurationInterface(bool hasInterface); @@ -195,7 +195,7 @@ public Q_SLOTS: protected: /** - * @arg engine name of the engine + * @param engine name of the engine * @return a data engine associated with this plasmoid */ Q_INVOKABLE DataEngine *dataEngine(const QString &engine) const; @@ -255,7 +255,7 @@ protected: /** * Loads an animation from the applet package - * @arg animation the animation to load + * @param animation the animation to load * @return an Animation object on success, a NULL pointer on failure * @since 4.5 */ diff --git a/scripting/scriptengine.h b/scripting/scriptengine.h index 610c10ec1..ed9acb6f9 100644 --- a/scripting/scriptengine.h +++ b/scripting/scriptengine.h @@ -94,7 +94,7 @@ private: }; /** - * @arg types a set of ComponentTypes flags for which to look up the + * @param types a set of ComponentTypes flags for which to look up the * language support for * @return a list of all supported languages for the given type(s). **/ diff --git a/service.h b/service.h index 126ea6f89..314909ba8 100644 --- a/service.h +++ b/service.h @@ -133,7 +133,7 @@ public: /** * Sets the destination for this Service to operate on * - * @arg destination specific to each Service, this sets which + * @param destination specific to each Service, this sets which * target or address for ServiceJobs to operate on */ Q_INVOKABLE void setDestination(const QString &destination); @@ -224,7 +224,7 @@ public: /** * @return a parameter map for the given description - * @arg description the configuration values to turn into the parameter map + * @param description the configuration values to turn into the parameter map * @since 4.4 */ Q_INVOKABLE QMap parametersFromDescription(const KConfigGroup &description); @@ -251,7 +251,7 @@ protected: /** * Default constructor * - * @arg parent the parent object for this service + * @param parent the parent object for this service */ explicit Service(QObject *parent = 0); @@ -288,7 +288,7 @@ protected: * Sets the name of the Service; useful for Services not loaded from plugins, * which use the plugin name for this. * - * @arg name the name to use for this service + * @param name the name to use for this service */ void setName(const QString &name); diff --git a/servicejob.h b/servicejob.h index 30660c58d..b55b70e2f 100644 --- a/servicejob.h +++ b/servicejob.h @@ -63,10 +63,10 @@ public: /** * Default constructor * - * @arg destination the subject that the job is acting on - * @arg operation the action that the job is performing on the @p destination - * @arg parameters the parameters of the @p action - * @arg parent the parent object for this service + * @param destination the subject that the job is acting on + * @param operation the action that the job is performing on the @p destination + * @param parameters the parameters of the @p action + * @param parent the parent object for this service */ ServiceJob(const QString &destination, const QString &operation, const QMap ¶meters, QObject *parent = 0); diff --git a/svg.h b/svg.h index 3b640aca5..9ec92f690 100644 --- a/svg.h +++ b/svg.h @@ -73,7 +73,7 @@ class PLASMA_EXPORT Svg : public QObject * * The size is initialized to be the SVG's native size. * - * @arg parent options QObject to parent this to + * @param parent options QObject to parent this to * * @related Plasma::Theme */ @@ -88,7 +88,7 @@ class PLASMA_EXPORT Svg : public QObject * size of the requested element after the whole SVG has been scaled * to size(). * - * @arg elementId the ID string of the element to render, or an empty + * @param elementId the ID string of the element to render, or an empty * string for the whole SVG (the default) * @return a QPixmap of the rendered SVG */ @@ -102,10 +102,10 @@ class PLASMA_EXPORT Svg : public QObject * be the size of the requested element after the whole SVG has been * scaled to size(). * - * @arg painter the QPainter to use - * @arg point the position to start drawing; the entire svg will be + * @param painter the QPainter to use + * @param point the position to start drawing; the entire svg will be * drawn starting at this point. - * @arg elementId the ID string of the element to render, or an empty + * @param elementId the ID string of the element to render, or an empty * string for the whole SVG (the default) */ Q_INVOKABLE void paint(QPainter *painter, const QPointF &point, @@ -119,10 +119,10 @@ class PLASMA_EXPORT Svg : public QObject * be the size of the requested element after the whole SVG has been * scaled to size(). * - * @arg painter the QPainter to use - * @arg x the horizontal coordinate to start painting from - * @arg y the vertical coordinate to start painting from - * @arg elementId the ID string of the element to render, or an empty + * @param painter the QPainter to use + * @param x the horizontal coordinate to start painting from + * @param y the vertical coordinate to start painting from + * @param elementId the ID string of the element to render, or an empty * string for the whole SVG (the default) */ Q_INVOKABLE void paint(QPainter *painter, int x, int y, @@ -131,10 +131,10 @@ class PLASMA_EXPORT Svg : public QObject /** * Paints all or part of the SVG represented by this object * - * @arg painter the QPainter to use - * @arg rect the rect to draw into; if smaller than the current size + * @param painter the QPainter to use + * @param rect the rect to draw into; if smaller than the current size * the drawing is starting at this point. - * @arg elementId the ID string of the element to render, or an empty + * @param elementId the ID string of the element to render, or an empty * string for the whole SVG (the default) */ Q_INVOKABLE void paint(QPainter *painter, const QRectF &rect, @@ -143,12 +143,12 @@ class PLASMA_EXPORT Svg : public QObject /** * Paints all or part of the SVG represented by this object * - * @arg painter the QPainter to use - * @arg x the horizontal coordinate to start painting from - * @arg y the vertical coordinate to start painting from - * @arg width the width of the element to draw - * @arg height the height of the element do draw - * @arg elementId the ID string of the element to render, or an empty + * @param painter the QPainter to use + * @param x the horizontal coordinate to start painting from + * @param y the vertical coordinate to start painting from + * @param width the width of the element to draw + * @param height the height of the element do draw + * @param elementId the ID string of the element to render, or an empty * string for the whole SVG (the default) */ Q_INVOKABLE void paint(QPainter *painter, int x, int y, int width, @@ -177,8 +177,8 @@ class PLASMA_EXPORT Svg : public QObject * image will be scaled to this size and each element will be * scaled appropriately. * - * @arg width the new width - * @arg height the new height + * @param width the new width + * @param height the new height **/ Q_INVOKABLE void resize(qreal width, qreal height); @@ -192,7 +192,7 @@ class PLASMA_EXPORT Svg : public QObject * image will be scaled to this size and each element will be * scaled appropriately. * - * @arg size the new size of the image + * @param size the new size of the image **/ Q_INVOKABLE void resize(const QSizeF &size); @@ -210,7 +210,7 @@ class PLASMA_EXPORT Svg : public QObject * has been scaled (see resize()). Note that this is unaffected by * the containsMultipleImages property. * - * @arg elementId the id of the element to check + * @param elementId the id of the element to check * @return the size of a given element, given the current size of the SVG **/ Q_INVOKABLE QSize elementSize(const QString &elementId) const; @@ -222,7 +222,7 @@ class PLASMA_EXPORT Svg : public QObject * the SVG has been scaled (see resize()). Note that this is * unaffected by the containsMultipleImages property. * - * @arg elementId the id of the element to check + * @param elementId the id of the element to check * @return the current rect of a given element, given the current size of the SVG **/ Q_INVOKABLE QRectF elementRect(const QString &elementId) const; @@ -230,7 +230,7 @@ class PLASMA_EXPORT Svg : public QObject /** * Check whether an element exists in the loaded SVG. * - * @arg elementId the id of the element to check for + * @param elementId the id of the element to check for * @return @c true if the element is defined in the SVG, otherwise @c false **/ Q_INVOKABLE bool hasElement(const QString &elementId) const; @@ -242,7 +242,7 @@ class PLASMA_EXPORT Svg : public QObject * * NOTE: not implemented! This will currently return an empty string! * - * @arg point a point in SVG co-ordinates + * @param point a point in SVG co-ordinates * @return an empty string */ Q_INVOKABLE QString elementAtPoint(const QPoint &point) const; @@ -268,7 +268,7 @@ class PLASMA_EXPORT Svg : public QObject * affects whether the elements are resized to size() by default. * See paint() and pixmap(). * - * @arg multiple true if the svg contains multiple images + * @param multiple true if the svg contains multiple images */ void setContainsMultipleImages(bool multiple); @@ -296,7 +296,7 @@ class PLASMA_EXPORT Svg : public QObject * relative paths will be searched for in the applet's package * first. * - * @arg svgFilePath either an absolute path to an SVG file, or + * @param svgFilePath either an absolute path to an SVG file, or * an image name */ void setImagePath(const QString &svgFilePath); @@ -345,7 +345,7 @@ class PLASMA_EXPORT Svg : public QObject * * This determines how relative image paths are interpreted. * - * @arg theme the theme object to use + * @param theme the theme object to use * @since 4.3 */ void setTheme(Plasma::Theme *theme); diff --git a/theme.h b/theme.h index f74a95963..e4618e2ba 100644 --- a/theme.h +++ b/theme.h @@ -89,15 +89,15 @@ class PLASMA_EXPORT Theme : public QObject /** * Default constructor. Usually you want to use the singleton instead. * @see defaultTheme - * @arg parent the parent object + * @param parent the parent object */ explicit Theme(QObject *parent = 0); /** * Construct a theme. Usually you want to use the singleton instead. * @see defaultTheme - * @arg themeName the name of the theme to create - * @arg parent the parent object + * @param themeName the name of the theme to create + * @param parent the parent object * @since 4.3 */ explicit Theme(const QString &themeName, QObject *parent = 0); @@ -128,7 +128,7 @@ class PLASMA_EXPORT Theme : public QObject /** * Retrieve the path for an SVG image in the current theme. * - * @arg name the name of the file in the theme directory (without the + * @param name the name of the file in the theme directory (without the * ".svg" part or a leading slash) * @return the full path to the requested file for the current theme */ @@ -137,7 +137,7 @@ class PLASMA_EXPORT Theme : public QObject /** * Retrieves the path for the script file that contains a given * Javascript animation. - * @arg the name of the animation + * @param the name of the animation * @return the full path to the script file, or an emptry string on failure * @since 4.5 */ @@ -146,7 +146,7 @@ class PLASMA_EXPORT Theme : public QObject /** * Retrieves the default wallpaper associated with this theme. * - * @arg size the target height and width of the wallpaper; if an invalid size + * @param size the target height and width of the wallpaper; if an invalid size * is passed in, then a default size will be provided instead. * @return the full path to the wallpaper image */ @@ -155,7 +155,7 @@ class PLASMA_EXPORT Theme : public QObject /** * Checks if this theme has an image named in a certain way * - * @arg name the name of the file in the theme directory (without the + * @param name the name of the file in the theme directory (without the * ".svg" part or a leading slash) * @return true if the image exists for this theme */ @@ -171,7 +171,7 @@ class PLASMA_EXPORT Theme : public QObject /** * Returns the text color to be used by items resting on the background * - * @arg role which role (usage pattern) to get the color for + * @param role which role (usage pattern) to get the color for */ Q_INVOKABLE QColor color(ColorRole role) const; @@ -179,15 +179,15 @@ class PLASMA_EXPORT Theme : public QObject * Sets the default font to be used with themed items. Defaults to * the application wide default font. * - * @arg font the new font - * @arg role which role (usage pattern) to set the font for + * @param font the new font + * @param role which role (usage pattern) to set the font for */ Q_INVOKABLE void setFont(const QFont &font, FontRole role = DefaultFont); /** * Returns the font to be used by themed items * - * @arg role which role (usage pattern) to get the font for + * @param role which role (usage pattern) to get the font for */ Q_INVOKABLE QFont font(FontRole role) const; @@ -205,7 +205,7 @@ class PLASMA_EXPORT Theme : public QObject * Tells the theme whether to follow the global settings or use application * specific settings * - * @arg useGlobal pass in true to follow the global settings + * @param useGlobal pass in true to follow the global settings */ void setUseGlobalSettings(bool useGlobal); @@ -328,9 +328,9 @@ class PLASMA_EXPORT Theme : public QObject /** * Tries to load the rect of a sub element from a disk cache * - * @arg image path of the image we want to check - * @arg element sub element we want to retrieve - * @arg rect output parameter of the element rect found in cache + * @param image path of the image we want to check + * @param element sub element we want to retrieve + * @param rect output parameter of the element rect found in cache * if not found or if we are sure it doesn't exist it will be QRect() * @return true if the element was found in cache or if we are sure the element doesn't exist **/ @@ -339,7 +339,7 @@ class PLASMA_EXPORT Theme : public QObject /** * Returns a list of all keys of cached rects for the given image. * - * @arg image path of the image for which the keys should be returned + * @param image path of the image for which the keys should be returned * * @return a QStringList whose elements are the entry keys in the rects cache * @@ -350,16 +350,16 @@ class PLASMA_EXPORT Theme : public QObject /** * Inserts a rectangle of a sub element of an image into a disk cache * - * @arg image path of the image we want to insert information - * @arg element sub element we want insert the rect - * @arg rect element rectangle + * @param image path of the image we want to insert information + * @param element sub element we want insert the rect + * @param rect element rectangle **/ void insertIntoRectsCache(const QString& image, const QString &element, const QRectF &rect); /** * Discards all the information about a given image from the rectangle disk cache * - * @arg image the path to the image the cache is assoiated with + * @param image the path to the image the cache is assoiated with **/ void invalidateRectsCache(const QString &image); @@ -368,7 +368,7 @@ class PLASMA_EXPORT Theme : public QObject * the permenant record of it on disk. * @see invalidateRectsCache * - * @arg image the path to the image the cache is assoiated with + * @param image the path to the image the cache is assoiated with */ void releaseRectsCache(const QString &image); diff --git a/tooltipmanager.h b/tooltipmanager.h index 083feaeac..3c31c77ae 100644 --- a/tooltipmanager.h +++ b/tooltipmanager.h @@ -156,7 +156,7 @@ public: /** * Sets the current state of the manager. * @see State - * @arg state the state to put the manager in + * @param state the state to put the manager in */ void setState(ToolTipManager::State state); @@ -168,9 +168,9 @@ public: Q_SIGNALS: /** * This signal is emitted when a window preview in the tooltip is clicked. - * @arg window the id of the window that was clicked - * @arg buttons the mouse buttons involved in the activation - * @arg modifiers the keyboard modifiers involved in the activation, if any + * @param window the id of the window that was clicked + * @param buttons the mouse buttons involved in the activation + * @param modifiers the keyboard modifiers involved in the activation, if any * @since 4.4 */ void windowPreviewActivated(WId window, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, @@ -178,9 +178,9 @@ Q_SIGNALS: /** * This signal is emitted when a link in the tooltip is clicked. - * @arg anchor the achor text (e.g. url) that was clicked on - * @arg buttons the mouse buttons involved in the activation - * @arg modifiers the keyboard modifiers involved in the activation, if any + * @param anchor the achor text (e.g. url) that was clicked on + * @param buttons the mouse buttons involved in the activation + * @param modifiers the keyboard modifiers involved in the activation, if any * @since 4.4 */ void linkActivated(const QString &anchor, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, diff --git a/view.h b/view.h index 2489ec564..bff3f7c65 100644 --- a/view.h +++ b/view.h @@ -53,17 +53,17 @@ public: * Constructs a view for a given contanment. An Id is automatically * assigned to the View. * - * @arg containment the containment to center the view on - * @arg parent the parent object for this view + * @param containment the containment to center the view on + * @param parent the parent object for this view */ explicit View(Containment *containment, QWidget *parent = 0); /** * Constructs a view for a given contanment. * - * @arg containment the containment to center the view on - * @arg viewId the id to assign to this view - * @arg parent the parent object for this view + * @param containment the containment to center the view on + * @param viewId the id to assign to this view + * @param parent the parent object for this view */ View(Containment *containment, int viewId, QWidget *parent = 0); @@ -84,8 +84,8 @@ public: * Sets which screen this view is associated with, if any. * This will also set the containment if a valid screen is specified * - * @arg screen the physical screen number; -1 for no screen - * @arg desktop the virtual desktop number, or -1 for all virtual desktops + * @param screen the physical screen number; -1 for no screen + * @param desktop the virtual desktop number, or -1 for all virtual desktops */ void setScreen(int screen, int desktop = -1); @@ -140,7 +140,7 @@ public: /** * Set whether or not the view should adjust its size when the associated * containment does. - * @arg trackChanges true to synchronize the view's size with the containment's + * @param trackChanges true to synchronize the view's size with the containment's * (this is the default behaviour), false to ignore containment size changes */ void setTrackContainmentChanges(bool trackChanges); @@ -189,7 +189,7 @@ public Q_SLOTS: * Sets the containment for this view, which will also cause the view * to track the geometry of the containment. * - * @arg containment the containment to center the view on + * @param containment the containment to center the view on */ virtual void setContainment(Plasma::Containment *containment); diff --git a/wallpaper.h b/wallpaper.h index e2d392642..e1e98914f 100644 --- a/wallpaper.h +++ b/wallpaper.h @@ -97,15 +97,15 @@ class PLASMA_EXPORT Wallpaper : public QObject /** * Returns a list of all known wallpapers. * - * @arg formFactor the format of the wallpaper being search for (e.g. desktop) + * @param formFactor the format of the wallpaper being search for (e.g. desktop) * @return list of wallpapers **/ static KPluginInfo::List listWallpaperInfo(const QString &formFactor = QString()); /** * Returns a list of all known wallpapers that can accept the given mimetype - * @arg mimetype the mimetype to search for - * @arg formFactor the format of the wallpaper being search for (e.g. desktop) + * @param mimetype the mimetype to search for + * @param formFactor the format of the wallpaper being search for (e.g. desktop) * @return list of wallpapers */ static KPluginInfo::List listWallpaperInfoForMimetype(const QString &mimetype, @@ -325,7 +325,7 @@ class PLASMA_EXPORT Wallpaper : public QObject * Wallpaper's current state, allowing for better selection of papers from packages, * for instance. * - * @arg resizeMethod The resize method to assume will be used for future wallpaper + * @param resizeMethod The resize method to assume will be used for future wallpaper * scaling; may later be changed by calls to render() * * @since 4.3 @@ -337,7 +337,7 @@ class PLASMA_EXPORT Wallpaper : public QObject * Wallpaper's current state, allowing for better selection of papers from packages, * for instance. * - * @arg targetSize The size to assume will be used for future wallpaper scaling + * @param targetSize The size to assume will be used for future wallpaper scaling * * @since 4.3 */ @@ -402,7 +402,7 @@ class PLASMA_EXPORT Wallpaper : public QObject /** * Emitted when a URL matching X-Plasma-DropMimeTypes is dropped on the wallpaper * - * @arg url the URL of the dropped file + * @param url the URL of the dropped file * @since 4.4 */ KDE_DEPRECATED void urlDropped(const KUrl &url); diff --git a/widgets/busywidget.h b/widgets/busywidget.h index e14ec4fa4..66bd0e9c7 100644 --- a/widgets/busywidget.h +++ b/widgets/busywidget.h @@ -48,7 +48,7 @@ public: /** * Constructs a new BusyWidget * - * @arg parent the parent of this widget + * @param parent the parent of this widget */ explicit BusyWidget(QGraphicsWidget *parent = 0); ~BusyWidget(); diff --git a/widgets/checkbox.h b/widgets/checkbox.h index 6e8d77f30..915e4a9f7 100644 --- a/widgets/checkbox.h +++ b/widgets/checkbox.h @@ -54,7 +54,7 @@ public: /** * Sets the display text for this CheckBox * - * @arg text the text to display; should be translated. + * @param text the text to display; should be translated. */ void setText(const QString &text); @@ -66,7 +66,7 @@ public: /** * Sets the path to an image to display. * - * @arg path the path to the image; if a relative path, then a themed image will be loaded. + * @param path the path to the image; if a relative path, then a themed image will be loaded. */ void setImage(const QString &path); @@ -78,7 +78,7 @@ public: /** * Sets the stylesheet used to control the visual display of this CheckBox * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -95,7 +95,7 @@ public: /** * Sets the checked state. * - * @arg checked true if checked, false if not + * @param checked true if checked, false if not */ void setChecked(bool checked); diff --git a/widgets/combobox.h b/widgets/combobox.h index 142b587de..4b67ee671 100644 --- a/widgets/combobox.h +++ b/widgets/combobox.h @@ -59,7 +59,7 @@ public: /** * Sets the stylesheet used to control the visual display of this ComboBox * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -71,7 +71,7 @@ public: /** * Sets the combo box wrapped by this ComboBox (widget must inherit KComboBox), ownership is transferred to the ComboBox * - * @arg combo box that will be wrapped by this ComboBox + * @param nativeWidget combo box that will be wrapped by this ComboBox * @since KDE4.4 */ void setNativeWidget(KComboBox *nativeWidget); diff --git a/widgets/frame.h b/widgets/frame.h index be1b1eed1..03f6da7e1 100644 --- a/widgets/frame.h +++ b/widgets/frame.h @@ -59,7 +59,7 @@ public: /** * Constructs a new Frame * - * @arg parent the parent of this widget + * @param parent the parent of this widget */ explicit Frame(QGraphicsWidget *parent = 0); ~Frame(); @@ -67,7 +67,7 @@ public: /** * Sets the Frame's shadow style * - * @arg shadow plain, raised or sunken + * @param shadow plain, raised or sunken */ void setFrameShadow(Shadow shadow); @@ -78,7 +78,7 @@ public: /** * Sets what borders should be painted - * @arg flags borders we want to paint + * @param flags borders we want to paint */ void setEnabledBorders(const FrameSvg::EnabledBorders borders); @@ -92,7 +92,7 @@ public: /** * Set the text to display by this Frame * - * @arg text the text + * @param text the text * @since 4.4 */ void setText(QString text); @@ -105,7 +105,7 @@ public: /** * Sets the path to an image to display. * - * @arg path the path to the image; if a relative path, then a themed image will be loaded. + * @param path the path to the image; if a relative path, then a themed image will be loaded. */ void setImage(const QString &path); @@ -117,7 +117,7 @@ public: /** * Sets the stylesheet used to control the visual display of this Frame * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); diff --git a/widgets/groupbox.h b/widgets/groupbox.h index 91d76b071..bc551c1f5 100644 --- a/widgets/groupbox.h +++ b/widgets/groupbox.h @@ -52,7 +52,7 @@ public: /** * Sets the display text for this GroupBox * - * @arg text the text to display; should be translated. + * @param text the text to display; should be translated. */ void setText(const QString &text); @@ -64,7 +64,7 @@ public: /** * Sets the stylesheet used to control the visual display of this GroupBox * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); diff --git a/widgets/iconwidget.h b/widgets/iconwidget.h index 7a4c298a5..78f392ee9 100644 --- a/widgets/iconwidget.h +++ b/widgets/iconwidget.h @@ -297,7 +297,7 @@ public: /** * Sets whether or not to draw a background area for the icon * - * @arg draw true if a background should be drawn or not + * @param draw true if a background should be drawn or not */ void setDrawBackground(bool draw); diff --git a/widgets/itembackground.h b/widgets/itembackground.h index 4e87d2306..86ab800ab 100644 --- a/widgets/itembackground.h +++ b/widgets/itembackground.h @@ -52,7 +52,7 @@ public: /** * Sets a new target geometry we want at the end of animation * - * @arg newGeometry the final geometry target + * @param newGeometry the final geometry target */ void setTarget(const QRectF &newGeometry); diff --git a/widgets/label.h b/widgets/label.h index 17f8bbd76..408eba8e1 100644 --- a/widgets/label.h +++ b/widgets/label.h @@ -55,7 +55,7 @@ public: /** * Constructs a label with word wrap on by default * - * @arg parent the parent of this widget + * @param parent the parent of this widget */ explicit Label(QGraphicsWidget *parent = 0); ~Label(); @@ -63,7 +63,7 @@ public: /** * Sets the display text for this Label * - * @arg text the text to display; should be translated. + * @param text the text to display; should be translated. */ void setText(const QString &text); @@ -75,7 +75,7 @@ public: /** * Sets the path to an image to display. * - * @arg path the path to the image; if a relative path, then a themed image will be loaded. + * @param path the path to the image; if a relative path, then a themed image will be loaded. */ void setImage(const QString &path); @@ -87,7 +87,7 @@ public: /** * Sets the alignment for the text * - * @arg the desired alignment + * @param the desired alignment */ void setAlignment(Qt::Alignment alignment); @@ -99,7 +99,7 @@ public: /** * Scale or not the contents of the label to the label size * - * @arg scale + * @param scale */ void setScaledContents(bool scaled); @@ -111,7 +111,7 @@ public: /** * Set if the text on the label can be selected with the mouse * - * @arg enable true if we want to manage text selection with the mouse + * @param enable true if we want to manage text selection with the mouse * @since 4.4 */ void setTextSelectable(bool enable); @@ -125,7 +125,7 @@ public: /** * Sets if the text of the label can wrap in multiple lines * - * @arg wrap multiple lines or not + * @param wrap multiple lines or not * @since 4.5 */ void setWordWrap(bool wrap); @@ -139,7 +139,7 @@ public: /** * Sets the stylesheet used to control the visual display of this Label * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); diff --git a/widgets/lineedit.h b/widgets/lineedit.h index 524bc9ef5..312b10402 100644 --- a/widgets/lineedit.h +++ b/widgets/lineedit.h @@ -54,7 +54,7 @@ public: /** * Sets the display text for this LineEdit * - * @arg text the text to display; should be translated. + * @param text the text to display; should be translated. */ void setText(const QString &text); @@ -92,7 +92,7 @@ public: /** * Sets the stylesheet used to control the visual display of this LineEdit * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -104,7 +104,7 @@ public: /** * Sets the line edit wrapped by this LineEdit (widget must inherit KLineEdit), ownership is transferred to the LineEdit * - * @arg text edit that will be wrapped by this LineEdit + * @param nativeWidget line edit that will be wrapped by this LineEdit * @since KDE4.4 */ void setNativeWidget(KLineEdit *nativeWidget); diff --git a/widgets/pushbutton.h b/widgets/pushbutton.h index 7819c8fe7..3d1becd38 100644 --- a/widgets/pushbutton.h +++ b/widgets/pushbutton.h @@ -60,7 +60,7 @@ public: /** * Sets the display text for this PushButton * - * @arg text the text to display; should be translated. + * @param text the text to display; should be translated. */ void setText(const QString &text); @@ -72,15 +72,15 @@ public: /** * Sets the path to an image to display. * - * @arg path the path to the image; if a relative path, then a themed image will be loaded. + * @param path the path to the image; if a relative path, then a themed image will be loaded. */ void setImage(const QString &path); /** * Sets the path to an svg image to display and the id of the used svg element, if necessary. * - * @arg path the path to the image; if a relative path, then a themed image will be loaded. - * @arg elementid the id of a svg element. + * @param path the path to the image; if a relative path, then a themed image will be loaded. + * @param elementid the id of a svg element. * * @since 4.4 */ @@ -94,7 +94,7 @@ public: /** * Sets the stylesheet used to control the visual display of this PushButton * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -122,7 +122,7 @@ public: /** * sets the icon for this push button * - * @arg icon the icon to use + * @param icon the icon to use * * @since 4.3 */ @@ -131,7 +131,7 @@ public: /** * sets the icon for this push button using a KIcon * - * @arg icon the icon to use + * @param icon the icon to use * * @since 4.4 */ diff --git a/widgets/radiobutton.h b/widgets/radiobutton.h index 6cec3170b..35054d116 100644 --- a/widgets/radiobutton.h +++ b/widgets/radiobutton.h @@ -54,7 +54,7 @@ public: /** * Sets the display text for this RadioButton * - * @arg text the text to display; should be translated. + * @param text the text to display; should be translated. */ void setText(const QString &text); @@ -66,7 +66,7 @@ public: /** * Sets the path to an image to display. * - * @arg path the path to the image; if a relative path, then a themed image will be loaded. + * @param path the path to the image; if a relative path, then a themed image will be loaded. */ void setImage(const QString &path); @@ -78,7 +78,7 @@ public: /** * Sets the stylesheet used to control the visual display of this RadioButton * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -95,7 +95,7 @@ public: /** * Sets the checked state. * - * @arg checked true if checked, false if not + * @param checked true if checked, false if not */ void setChecked(bool checked); diff --git a/widgets/scrollbar.h b/widgets/scrollbar.h index 7ed61905e..f5007f9e5 100644 --- a/widgets/scrollbar.h +++ b/widgets/scrollbar.h @@ -59,15 +59,15 @@ public: /** * Sets the scrollbar minimum and maximum values - * @arg min minimum value - * @arg max maximum value + * @param min minimum value + * @param max maximum value */ void setRange(int min, int max); /** * Sets the amount of the single step * i.e how much the slider will move when the user press an arrow button - * @arg val + * @param val */ void setSingleStep(int val); @@ -78,7 +78,7 @@ public: /** * Sets the amount the slider will scroll when the user press page up or page down - * @arg val + * @param val */ void setPageStep(int val); @@ -103,13 +103,13 @@ public: int maximum() const; /** - * @arg the minimum value bound of this ScrollBar + * @param the minimum value bound of this ScrollBar * @since 4.6 */ void setMinimum(const int min) const; /** - * @arg the maximum value bound of this ScrollBar + * @param the maximum value bound of this ScrollBar * @since 4.6 */ void setMaximum(const int max) const; @@ -117,7 +117,7 @@ public: /** * Sets the stylesheet used to control the visual display of this ScrollBar * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -143,7 +143,7 @@ protected: public Q_SLOTS: /** * Sets the current value for the ScrollBar - * @arg value must be minimum() <= value <= maximum() + * @param value must be minimum() <= value <= maximum() */ void setValue(int val); diff --git a/widgets/scrollwidget.h b/widgets/scrollwidget.h index ad15a38ba..5ea476b2e 100644 --- a/widgets/scrollwidget.h +++ b/widgets/scrollwidget.h @@ -60,7 +60,7 @@ public: /** * Constructs a new ScrollWidget * - * @arg parent the parent of this widget + * @param parent the parent of this widget */ explicit ScrollWidget(QGraphicsWidget *parent = 0); explicit ScrollWidget(QGraphicsItem *parent); @@ -74,7 +74,7 @@ public: * it will be resized when possible, otherwise it will be kept to whichever * width the widget resizes itself. * - * @arg widget the new main sub widget + * @param widget the new main sub widget */ void setWidget(QGraphicsWidget *widget); @@ -114,7 +114,7 @@ public: /** * Sets the horizontal scrollbar policy * - * @arg policy desired policy + * @param policy desired policy */ void setHorizontalScrollBarPolicy(const Qt::ScrollBarPolicy policy); @@ -126,7 +126,7 @@ public: /** * Sets the vertical scrollbar policy * - * @arg policy desired policy + * @param policy desired policy */ void setVerticalScrollBarPolicy(const Qt::ScrollBarPolicy policy); @@ -226,7 +226,7 @@ public: * Set the nap size of the kinetic scrolling: * the scrolling will always stop at multiples of that size. * - * @arg the desired snap size + * @param the desired snap size * @since 4.5 */ void setSnapSize(const QSizeF &size); @@ -240,7 +240,7 @@ public: /** * Sets the stylesheet used to control the visual display of this ScrollWidget * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); diff --git a/widgets/slider.h b/widgets/slider.h index a9834fd20..5a80d9e35 100644 --- a/widgets/slider.h +++ b/widgets/slider.h @@ -75,7 +75,7 @@ public: /** * Sets the stylesheet used to control the visual display of this Slider * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); diff --git a/widgets/spinbox.h b/widgets/spinbox.h index fdced70ef..3c49e0a41 100644 --- a/widgets/spinbox.h +++ b/widgets/spinbox.h @@ -70,7 +70,7 @@ public: /** * Sets the stylesheet used to control the visual display of this SpinBox * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); diff --git a/widgets/tabbar.h b/widgets/tabbar.h index b6c3f8636..70641d32e 100644 --- a/widgets/tabbar.h +++ b/widgets/tabbar.h @@ -59,7 +59,7 @@ public: /** * Constructs a new TabBar * - * @arg parent the parent of this widget + * @param parent the parent of this widget */ explicit TabBar(QGraphicsWidget *parent = 0); ~TabBar(); @@ -67,12 +67,12 @@ public: /** * Adds a new tab in the desired position * - * @arg index the position where to insert the new tab, + * @param index the position where to insert the new tab, * if index <=0 will be the first position, * if index >= count() will be the last - * @arg icon the icon for this tab - * @arg label the text label of the tab - * @arg content the page content that will be shown by this tab + * @param icon the icon for this tab + * @param label the text label of the tab + * @param content the page content that will be shown by this tab * @return the index of the inserted tab */ Q_INVOKABLE int insertTab(int index, const QIcon &icon, const QString &label, @@ -83,11 +83,11 @@ public: * This is an overloaded member provided for convenience * equivalent to insertTab(index, QIcon(), label); * - * @arg index the position where to insert the new tab, + * @param index the position where to insert the new tab, * if index <=0 will be the first position, * if index >= count() will be the last - * @arg label the text label of the tab - * @arg content the page content that will be shown by this tab + * @param label the text label of the tab + * @param content the page content that will be shown by this tab * @return the index of the inserted tab */ Q_INVOKABLE int insertTab(int index, const QString &label, QGraphicsLayoutItem *content = 0); @@ -95,9 +95,9 @@ public: /** * Adds a new tab in the last position * - * @arg icon the icon for this tab - * @arg label the text label of the tab - * @arg content the page content that will be shown by this tab + * @param icon the icon for this tab + * @param label the text label of the tab + * @param content the page content that will be shown by this tab * @return the index of the inserted tab */ Q_INVOKABLE int addTab(const QIcon &icon, const QString &label, QGraphicsLayoutItem *content = 0); @@ -107,8 +107,8 @@ public: * This is an overloaded member provided for convenience * equivalent to addTab(QIcon(), label, page) * - * @arg label the text label of the tab - * @arg content the page content that will be shown by this tab + * @param label the text label of the tab + * @param content the page content that will be shown by this tab * @return the index of the inserted tab */ Q_INVOKABLE int addTab(const QString &label, QGraphicsLayoutItem *content = 0); @@ -116,14 +116,14 @@ public: /** * Removes a tab, contents are deleted * - * @arg index the index of the tab to remove + * @param index the index of the tab to remove */ Q_INVOKABLE void removeTab(int index); /** * Removes a tab, the page is reparented to 0 and is returned * - * @arg index the index of the tab to remove + * @param index the index of the tab to remove * @since 4.4 */ Q_INVOKABLE QGraphicsLayoutItem *takeTab(int index); @@ -131,7 +131,7 @@ public: /** * Returns the contents of a page * - * @arg index the index of the tab to retrieve + * @param index the index of the tab to retrieve * @since 4.4 */ Q_INVOKABLE QGraphicsLayoutItem *tabAt(int index); @@ -149,30 +149,30 @@ public: /** * Sets the text label of the given tab * - * @arg index the index of the tab to modify - * @arg label the new text label of the given tab + * @param index the index of the tab to modify + * @param label the new text label of the given tab */ Q_INVOKABLE void setTabText(int index, const QString &label); /** * @return the text label of the given tab * - * @arg index the index of the tab we want to know its label + * @param index the index of the tab we want to know its label */ Q_INVOKABLE QString tabText(int index) const; /** * Sets an icon for a given tab * - * @arg index the index of the tab to modify - * @arg icon the new icon for the given tab + * @param index the index of the tab to modify + * @param icon the new icon for the given tab */ Q_INVOKABLE void setTabIcon(int index, const QIcon &icon); /** * @return the current icon for a given tab * - * @arg index the index of the tab we want to know its icon + * @param index the index of the tab we want to know its icon */ Q_INVOKABLE QIcon tabIcon(int index) const; @@ -181,7 +181,7 @@ public: * pages, when the tabbar doesn't have content pages at all this * function has no effect * - * @arg show true if we want to show the tabbar + * @param show true if we want to show the tabbar * @since 4.3 */ void setTabBarShown(bool show); @@ -195,7 +195,7 @@ public: /** * Sets the stylesheet used to control the visual display of this TabBar * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -257,7 +257,7 @@ public Q_SLOTS: /** * Activate a given tab * - * @arg index the index of the tab to activate + * @param index the index of the tab to activate */ void setCurrentIndex(int index); @@ -265,7 +265,7 @@ Q_SIGNALS: /** * Emitted when the active tab changes * - * @arg index the newly activated tab + * @param index the newly activated tab */ void currentChanged(int index); diff --git a/widgets/textbrowser.h b/widgets/textbrowser.h index ca5ab4794..041bbbc62 100644 --- a/widgets/textbrowser.h +++ b/widgets/textbrowser.h @@ -55,7 +55,7 @@ public: /** * Sets the display text for this TextBrowser * - * @arg text the text to display; should be translated. + * @param text the text to display; should be translated. */ void setText(const QString &text); @@ -77,7 +77,7 @@ public: /** * Sets the stylesheet used to control the visual display of this TextBrowser * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); diff --git a/widgets/textedit.h b/widgets/textedit.h index 1c4e4b8f6..0e4b7ee74 100644 --- a/widgets/textedit.h +++ b/widgets/textedit.h @@ -54,7 +54,7 @@ public: /** * Sets the display text for this TextEdit * - * @arg text the text to display; should be translated. + * @param text the text to display; should be translated. */ void setText(const QString &text); @@ -65,7 +65,7 @@ public: /** * Sets the text area to be read only or interactive - * @arg true to make it read only, false for interactive + * @param true to make it read only, false for interactive * @since 4.4 */ void setReadOnly(bool readOnly); @@ -78,7 +78,7 @@ public: /** * Sets the stylesheet used to control the visual display of this TextEdit * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -90,7 +90,7 @@ public: /** * Sets the text edit wrapped by this TextEdit (widget must inherit KTextEdit), ownership is transferred to the TextEdit * - * @arg text edit that will be wrapped by this TextEdit + * @param nativeWidget text edit that will be wrapped by this TextEdit * @since KDE4.4 */ void setNativeWidget(KTextEdit *nativeWidget); diff --git a/widgets/toolbutton.h b/widgets/toolbutton.h index 77f48dc81..3c891f9b2 100644 --- a/widgets/toolbutton.h +++ b/widgets/toolbutton.h @@ -58,7 +58,7 @@ public: /** * Sets if the toolbutton has an autoraise behaviour * - * @arg raise + * @param raise */ void setAutoRaise(bool raise); @@ -70,7 +70,7 @@ public: /** * Sets the display text for this ToolButton * - * @arg text the text to display; should be translated. + * @param text the text to display; should be translated. */ void setText(const QString &text); @@ -82,15 +82,15 @@ public: /** * Sets the path to an image to display. * - * @arg path the path to the image; if a relative path, then a themed image will be loaded. + * @param path the path to the image; if a relative path, then a themed image will be loaded. */ void setImage(const QString &path); /** * Sets the path to an svg image to display and the id of the used svg element, if necessary. * - * @arg path the path to the image; if a relative path, then a themed image will be loaded. - * @arg elementid the id of a svg element. + * @param path the path to the image; if a relative path, then a themed image will be loaded. + * @param elementid the id of a svg element. * * @since 4.4 */ @@ -104,7 +104,7 @@ public: /** * Sets the status of the button to pressed * - * @arg down + * @param down * @since 4.5 */ void setDown(bool down); @@ -118,7 +118,7 @@ public: /** * Sets the stylesheet used to control the visual display of this ToolButton * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -146,7 +146,7 @@ public: /** * sets the icon for this toolbutton * - * @arg icon the icon we want to use + * @param icon the icon we want to use * * @since 4.3 */ diff --git a/widgets/treeview.h b/widgets/treeview.h index 2d753adb7..58224eb83 100644 --- a/widgets/treeview.h +++ b/widgets/treeview.h @@ -53,7 +53,7 @@ public: /** * Sets a model for this weather view * - * @arg model the model to display + * @param model the model to display */ void setModel(QAbstractItemModel *model); @@ -65,7 +65,7 @@ public: /** * Sets the stylesheet used to control the visual display of this TreeView * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); diff --git a/widgets/videowidget.h b/widgets/videowidget.h index 267c313ff..bbf3ce9ac 100644 --- a/widgets/videowidget.h +++ b/widgets/videowidget.h @@ -79,7 +79,7 @@ public: /** * Load a certain url that can be a local file or a remote one - * @arg path resource to play + * @param path resource to play */ void setUrl(const QString &url); @@ -118,7 +118,7 @@ public: /** * Set what control widgets to use * - * @arg controls bitwise OR combination of Controls flags + * @param controls bitwise OR combination of Controls flags * @see Controls */ void setUsedControls(const Controls controls); @@ -132,7 +132,7 @@ public: /** * Show/hide the main controls widget, if any of them is used * - * @arg visible if we want to show or hide the main controls + * @param visible if we want to show or hide the main controls * @see setUsedControls() */ void setControlsVisible(bool visible); @@ -145,7 +145,7 @@ public: /** * Sets the stylesheet used to control the visual display of this VideoWidget * - * @arg stylesheet a CSS string + * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); @@ -178,14 +178,14 @@ public Q_SLOTS: /** * Jump at a given millisecond in the current file - * @arg time where we want to jump + * @param time where we want to jump */ void seek(qint64 time); Q_SIGNALS: /** * Emitted regularly when the playing is progressing - * @arg time where we are + * @param time where we are */ void tick(qint64 time); diff --git a/windoweffects.h b/windoweffects.h index 80534ee5f..6a1acd096 100644 --- a/windoweffects.h +++ b/windoweffects.h @@ -57,10 +57,10 @@ namespace WindowEffects /** * Mark a window as sliding from screen edge * - * @arg id of the window on which we want to apply the effect - * @arg location edge of the screen from which we want the sliding effect. + * @param id of the window on which we want to apply the effect + * @param location edge of the screen from which we want the sliding effect. * Desktop and Floating won't have effect. - * @arg offset distance in pixels from the screen edge defined by location + * @param offset distance in pixels from the screen edge defined by location * @since 4.4 */ PLASMA_EXPORT void slideWindow(WId id, Plasma::Location location, int offset); @@ -69,8 +69,8 @@ namespace WindowEffects * Mark a window as sliding from screen edge * This is an overloaded member function provided for convenience * - * @arg widget QWidget corresponding to the top level window we want to animate - * @arg location edge of the screen from which we want the sliding effect. + * @param widget QWidget corresponding to the top level window we want to animate + * @param location edge of the screen from which we want the sliding effect. * Desktop and Floating won't have effect. * @since 4.4 */