[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: KDE/kdelibs/plasma
From: Alex Merry <kde () randomguy3 ! me ! uk>
Date: 2009-01-10 0:08:32
Message-ID: 1231546112.691739.11560.nullmailer () svn ! kde ! org
[Download RAW message or body]
SVN commit 908604 by alexmerry:
apidocs fixes.
Remember to document ALL parameters to methods. They may seem obvious to you, but I \
had to look at the code for at least two of the methods in order to document their \
parameters correctly.
*waves stick of EBN-ness*
M +1 -2 abstractrunner.h
M +3 -0 applet.h
M +14 -7 containment.h
M +4 -3 corona.h
M +1 -0 datacontainer.h
M +4 -0 package.h
M +3 -3 packagestructure.h
M +1 -1 plasma.h
M +2 -0 scripting/appletscript.h
M +1 -1 scripting/scriptengine.h
M +1 -1 service.h
M +1 -1 version.h
M +4 -4 wallpaper.h
M +6 -6 widgets/meter.h
M +1 -1 widgets/webview.h
--- trunk/KDE/kdelibs/plasma/abstractrunner.h #908603:908604
@@ -119,13 +119,12 @@
* 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
*/
--- trunk/KDE/kdelibs/plasma/applet.h #908603:908604
@@ -721,6 +721,9 @@
*
* @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());
--- trunk/KDE/kdelibs/plasma/containment.h #908603:908604
@@ -224,12 +224,14 @@
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 @@
void destroy(bool confirm);
/**
- * @reimplemented from Plasma::Applet
+ * @reimp
+ * @sa Applet::showConfigurationInterface()
*/
void showConfigurationInterface();
@@ -475,22 +478,26 @@
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);
--- trunk/KDE/kdelibs/plasma/corona.h #908603:908604
@@ -139,12 +139,13 @@
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
--- trunk/KDE/kdelibs/plasma/datacontainer.h #908603:908604
@@ -117,6 +117,7 @@
*
* @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);
--- trunk/KDE/kdelibs/plasma/package.h #908603:908604
@@ -137,6 +137,8 @@
* @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 @@
* @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,
--- trunk/KDE/kdelibs/plasma/packagestructure.h #908603:908604
@@ -164,7 +164,7 @@
* 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 @@
* 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 @@
* 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);
--- trunk/KDE/kdelibs/plasma/plasma.h #908603:908604
@@ -244,7 +244,7 @@
* 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);
--- trunk/KDE/kdelibs/plasma/scripting/appletscript.h #908603:908604
@@ -74,6 +74,8 @@
*
* @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,
--- trunk/KDE/kdelibs/plasma/scripting/scriptengine.h #908603:908604
@@ -131,7 +131,7 @@
/**
* 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
*/
--- trunk/KDE/kdelibs/plasma/service.h #908603:908604
@@ -112,7 +112,7 @@
/**
* 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);
--- trunk/KDE/kdelibs/plasma/version.h #908603:908604
@@ -20,7 +20,7 @@
#ifndef PLASMA_VERSION_H
#define PLASMA_VERSION_H
-/** @header plasma/version.h <Plasma/Version> */
+/** @file plasma/version.h <Plasma/Version> */
#include <plasma/plasma_export.h>
--- trunk/KDE/kdelibs/plasma/wallpaper.h #908603:908604
@@ -41,7 +41,7 @@
* Wallpaper plugins are registered using .desktop files. These files should be
* named using the following naming scheme:
*
- * plasma-wallpaper-<pluginname>.desktop
+ * plasma-wallpaper-\<pluginname\>.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 @@
/**
* 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);
--- trunk/KDE/kdelibs/plasma/widgets/meter.h #908603:908604
@@ -152,8 +152,8 @@
/**
* 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 @@
/**
* 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 @@
/**
* 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);
--- trunk/KDE/kdelibs/plasma/widgets/webview.h #908603:908604
@@ -39,7 +39,7 @@
class WebViewPrivate;
/**
- * @class WebView plasma/widgets/webcontent.h <Plasma/Widgets/WebView>
+ * @class WebView plasma/widgets/webview.h <Plasma/Widgets/WebView>
*
* @short Provides a widget to display html content in Plasma.
*/
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic