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* svn path=/trunk/KDE/kdelibs/; revision=908604
This commit is contained in:
parent
32d2b4c4c9
commit
9c1570f13e
@ -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
|
||||
*/
|
||||
|
3
applet.h
3
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());
|
||||
|
||||
|
@ -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);
|
||||
|
||||
|
7
corona.h
7
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
|
||||
|
@ -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);
|
||||
|
@ -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,
|
||||
|
@ -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);
|
||||
|
||||
|
2
plasma.h
2
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);
|
||||
|
||||
|
@ -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,
|
||||
|
@ -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
|
||||
*/
|
||||
|
@ -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);
|
||||
|
@ -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>
|
||||
|
||||
|
@ -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-<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 @@ 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);
|
||||
|
||||
|
@ -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);
|
||||
|
||||
|
@ -39,7 +39,7 @@ namespace Plasma
|
||||
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.
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user