From faaa5b009c20415b7374a6ed269c295507e4207f Mon Sep 17 00:00:00 2001 From: Alex Merry Date: Sat, 10 Jan 2009 00:22:56 +0000 Subject: [PATCH] Backport of apidocs changes, so that the 4.2-branch apidocs are correct svn path=/branches/KDE/4.2/kdelibs/; revision=908609 --- abstractrunner.h | 3 +-- applet.h | 3 +++ containment.h | 21 ++++++++++++++------- corona.h | 7 ++++--- datacontainer.h | 1 + package.h | 4 ++++ packagestructure.h | 6 +++--- plasma.h | 2 +- scripting/appletscript.h | 2 ++ scripting/scriptengine.h | 2 +- service.h | 2 +- version.h | 2 +- wallpaper.h | 8 ++++---- widgets/meter.h | 12 ++++++------ widgets/webview.h | 2 +- 15 files changed, 47 insertions(+), 30 deletions(-) diff --git a/abstractrunner.h b/abstractrunner.h index b50895975..6150cf81b 100644 --- a/abstractrunner.h +++ b/abstractrunner.h @@ -119,13 +119,12 @@ class PLASMA_EXPORT AbstractRunner : public QObject * If a particular match supports multiple actions, set up the corresponding * actions in the actionsForMatch method. Do not call any of the action methods * within this method! - * @see actionsForMatch * * Execution of the correct action should be handled in the run method. * @caution This method needs to be thread-safe since KRunner will simply * start a new thread for each new term. * - * @caution Returning from this method means to end execution of the runner. + * @warning Returning from this method means to end execution of the runner. * * @sa run(), RunnerContext::addMatch, RunnerContext::addMatches, QueryMatch */ diff --git a/applet.h b/applet.h index 19ece2018..3239bd9f9 100644 --- a/applet.h +++ b/applet.h @@ -721,6 +721,9 @@ class PLASMA_EXPORT Applet : public QGraphicsWidget * * @param needsConfiguring true if the applet needs to be configured, * or false if it doesn't + * @param reason a translated message for the user explaining that the + * applet needs configuring; this should note what needs + * to be configured */ void setConfigurationRequired(bool needsConfiguring, const QString &reason = QString()); diff --git a/containment.h b/containment.h index b626015c1..354ccb751 100644 --- a/containment.h +++ b/containment.h @@ -224,12 +224,14 @@ class PLASMA_EXPORT Containment : public Applet int desktop() const; /** - * @reimplemented from Applet + * @reimp + * @sa Applet::save(KConfigGroup &) */ void save(KConfigGroup &group) const; /** - * @reimplemented from Applet + * @reimp + * @sa Applet::restore(KConfigGroup &) */ void restore(KConfigGroup &group); @@ -434,7 +436,8 @@ class PLASMA_EXPORT Containment : public Applet void destroy(bool confirm); /** - * @reimplemented from Plasma::Applet + * @reimp + * @sa Applet::showConfigurationInterface() */ void showConfigurationInterface(); @@ -475,22 +478,26 @@ class PLASMA_EXPORT Containment : public Applet QVariant itemChange(GraphicsItemChange change, const QVariant &value); /** - * @reimplemented from QGraphicsItem + * @reimp + * @sa QGraphicsItem::dragEnterEvent() */ void dragEnterEvent(QGraphicsSceneDragDropEvent *event); /** - * @reimplemented from QGraphicsItem + * @reimp + * @sa QGraphicsItem::dragMoveEvent() */ void dragMoveEvent(QGraphicsSceneDragDropEvent *event); /** - * @reimplemented from QGraphicsItem + * @reimp + * @sa QGraphicsItem::dropEvent() */ void dropEvent(QGraphicsSceneDragDropEvent *event); /** - * @reimplemented from QGraphicsItem + * @reimp + * @sa QGraphicsItem::resizeEvent() */ void resizeEvent(QGraphicsSceneResizeEvent *event); diff --git a/corona.h b/corona.h index 647fa9f5f..c29f4de99 100644 --- a/corona.h +++ b/corona.h @@ -139,12 +139,13 @@ public: virtual QRegion availableScreenRegion(int id) const; /** - * Reccomended position for a popup window like a menu or a tooltip + * Recommended position for a popup window like a menu or a tooltip * given its size - * @param s size of the popup + * @param item the item that the popup should appear adjacent to (an applet, say) + * @param size size of the popup * @returns reccomended position */ - QPoint popupPosition(const QGraphicsItem *item, const QSize &s); + QPoint popupPosition(const QGraphicsItem *item, const QSize &size); /** * This method is useful in order to retrieve the list of available diff --git a/datacontainer.h b/datacontainer.h index 87efad8a5..435e6bbf4 100644 --- a/datacontainer.h +++ b/datacontainer.h @@ -117,6 +117,7 @@ class PLASMA_EXPORT DataContainer : public QObject * * @param visualization the object to connect to this DataContainer * @param pollingInterval the time in milliseconds between updates + * @param alignment the clock position to align updates to **/ void connectVisualization(QObject *visualization, uint pollingInterval, Plasma::IntervalAlignment alignment); diff --git a/package.h b/package.h index 67bd6112a..8decf00fe 100644 --- a/package.h +++ b/package.h @@ -137,6 +137,8 @@ class PLASMA_EXPORT Package * @param package path to the Plasmagik package * @param packageRoot path to the directory where the package should be * installed to + * @param servicePrefix the prefix for the desktop file, so as not to interfere + * with unrelated services (eg: "plasma-applet-") * @return true on successful installation, false otherwise **/ static bool installPackage(const QString &package, @@ -149,6 +151,8 @@ class PLASMA_EXPORT Package * @param package path to the Plasmagik package * @param packageRoot path to the directory where the package should be * installed to + * @param servicePrefix the prefix for the desktop file, so as not to interfere + * with unrelated services (eg: "plasma-applet-") * @return true on successful uninstallation, false otherwise **/ static bool uninstallPackage(const QString &package, diff --git a/packagestructure.h b/packagestructure.h index cd4b5ef85..6772feaa1 100644 --- a/packagestructure.h +++ b/packagestructure.h @@ -164,7 +164,7 @@ public: * The path must already have been added using addDirectoryDefinition * or addFileDefinition. * - * @param path the path of the entry within the package + * @param key the entry within the package * @param required true if this entry is required, false if not */ void setRequired(const char *key, bool required); @@ -188,7 +188,7 @@ public: * The path must already have been added using addDirectoryDefinition * or addFileDefinition. * - * @param path the path of the entry within the package + * @param key the entry within the package * @param mimetypes a list of mimetypes **/ void setMimetypes(const char *key, QStringList mimetypes); @@ -249,7 +249,7 @@ public: * When the process is complete, the newWidgetBrowserFinished() signal must be * emitted. * - * @args parent the parent widget to use for the widget + * @param parent the parent widget to use for the widget */ virtual void createNewWidgetBrowser(QWidget *parent = 0); diff --git a/plasma.h b/plasma.h index 21f3b5bbf..61b365a03 100644 --- a/plasma.h +++ b/plasma.h @@ -244,7 +244,7 @@ PLASMA_EXPORT qreal scalingFactor(ZoomLevel level); * location or to point arrows and other directional items. * * @param location the location of the container the element will appear in - * @reutrn the visual direction of the element should be oriented in + * @return the visual direction of the element should be oriented in **/ PLASMA_EXPORT Direction locationToDirection(Location location); diff --git a/scripting/appletscript.h b/scripting/appletscript.h index 29778ebf8..933292c57 100644 --- a/scripting/appletscript.h +++ b/scripting/appletscript.h @@ -74,6 +74,8 @@ public: * * @param painter the QPainter to use * @param option the style option containing such flags as selection, level of detail, etc + * @param contentsRect the rect to paint within; automatically adjusted for + * the background, if any */ virtual void paintInterface(QPainter *painter, const QStyleOptionGraphicsItem *option, diff --git a/scripting/scriptengine.h b/scripting/scriptengine.h index c336a2ecc..64b86ae63 100644 --- a/scripting/scriptengine.h +++ b/scripting/scriptengine.h @@ -131,7 +131,7 @@ PLASMA_EXPORT RunnerScript *loadScriptEngine(const QString &language, AbstractRu /** * Loads an appropriate PackageStructure for the given language and type * - * @param langauge the language to load the PackageStructure for + * @param language the language to load the PackageStructure for * @param type the component type * @return a guarded PackageStructure pointer */ diff --git a/service.h b/service.h index c7aa1e09c..e7cc853bc 100644 --- a/service.h +++ b/service.h @@ -112,7 +112,7 @@ public: /** * Retrieves the parameters for a given operation * - * @param operation the operation to retrieve parameters for + * @param operationName the operation to retrieve parameters for * @return KConfigGroup containing the parameters */ Q_INVOKABLE KConfigGroup operationDescription(const QString &operationName); diff --git a/version.h b/version.h index adb676a75..8d5956476 100644 --- a/version.h +++ b/version.h @@ -20,7 +20,7 @@ #ifndef PLASMA_VERSION_H #define PLASMA_VERSION_H -/** @header plasma/version.h */ +/** @file plasma/version.h */ #include diff --git a/wallpaper.h b/wallpaper.h index 416e1b215..00204f97d 100644 --- a/wallpaper.h +++ b/wallpaper.h @@ -41,7 +41,7 @@ class WallpaperPrivate; * Wallpaper plugins are registered using .desktop files. These files should be * named using the following naming scheme: * - * plasma-wallpaper-.desktop + * plasma-wallpaper-\.desktop * * If a wallpaper plugin provides more than on mode (e.g. Single Image, Wallpaper) * it should include a Actions= entry in the .desktop file, listing the possible @@ -223,10 +223,10 @@ class PLASMA_EXPORT Wallpaper : public QObject /** * This method is called once the wallpaper is loaded or mode is changed. - * The mode can be retrieved using the @see renderMode() method. + * + * The mode can be retrieved using the renderMode() method. + * * @param config Config group to load settings - * @param mode One of the modes supported by the plugin, - * or an empty string for the default mode. **/ virtual void init(const KConfigGroup &config); diff --git a/widgets/meter.h b/widgets/meter.h index 451c6c750..bdd4e321c 100644 --- a/widgets/meter.h +++ b/widgets/meter.h @@ -152,8 +152,8 @@ public: /** * Set text label color for the meter - * @param index label index. - * @param text color for the label. + * @param index label index + * @param color the color to apply to the label */ void setLabelColor(int index, const QColor &color); @@ -165,8 +165,8 @@ public: /** * Set text label font for the meter - * @param index label index. - * @param text font for the label. + * @param index label index + * @param font the font to apply to the label */ void setLabelFont(int index, const QFont &font); @@ -178,8 +178,8 @@ public: /** * Set text label alignment for the meter - * @param index label index. - * @param text alignment for the label. + * @param index label index + * @param alignment the text alignment to apply to the label */ void setLabelAlignment(int index, const Qt::Alignment alignment); diff --git a/widgets/webview.h b/widgets/webview.h index 5ff7d82c5..8395197e0 100644 --- a/widgets/webview.h +++ b/widgets/webview.h @@ -39,7 +39,7 @@ namespace Plasma class WebViewPrivate; /** - * @class WebView plasma/widgets/webcontent.h + * @class WebView plasma/widgets/webview.h * * @short Provides a widget to display html content in Plasma. */