Commit 52528f6a authored by Yuri Chornoivan's avatar Yuri Chornoivan

Fix minor Doxygen issues

parent 91c359e1
......@@ -302,13 +302,13 @@ public:
* @param dst the destination that will be draw on the image, and this function
* will edit its alpha channel
* @param coloringInfo coloring information that will be copied on the dab, it can be null
* @param scale a scale applied on the alpha mask
* @param angle a rotation applied on the alpha mask
* @param shape a shape applied on the alpha mask
* @param info the painting information (this is only and should only be used by
* KisImagePipeBrush and only to be backward compatible with the Gimp,
* KisImagePipeBrush is ignoring scale and angle information)
* @param subPixelX sub position of the brush (contained between 0.0 and 1.0)
* @param subPixelY sub position of the brush (contained between 0.0 and 1.0)
* @param softnessFactor softness factor of the brush
*
* @return a mask computed from the grey-level values of the
* pixels in the brush.
......
......@@ -80,19 +80,16 @@ public:
/**
* @brief Paint the handles
*
* @param painter the painter to paint the handles on
* @param converter the view converter for applying the actual zoom
* @param handleRadius the radius of the handles used for painting
* @param handlesHelper the helper of the handles used for painting
* @sa KisHandlePainterHelper
*/
void paintHandles(KisHandlePainterHelper &handlesHelper);
/**
* @brief Paint the given handles
*
* @param painter the painter to paint the handles on
* @param converter the view converter for applying the actual zoom
* @param handlesHelper the helper of the handle used for painting
* @param handleId of the handle which should be repainted
* @param handleRadius the radius of the handle used for painting
*/
void paintHandle(KisHandlePainterHelper &handlesHelper, int handleId);
......
......@@ -61,7 +61,7 @@ public:
/**
* Set a resource of type KoShape*.
* @param key the integer key
* @param id the new value for the key.
* @param shape the new shape for the key.
* @see KoCanvasResourceProvider::CanvasResource KoDocumentResourceManager::DocumentResource
*/
void setResource(int key, KoShape *shape);
......@@ -69,7 +69,7 @@ public:
/**
* Set a resource of type KoUnit
* @param key the integer key
* @param id the new value for the key.
* @param unit the unit for the key.
* @see KoCanvasResourceProvider::CanvasResource KoDocumentResourceManager::DocumentResource
*/
void setResource(int key, const KoUnit &unit);
......
......@@ -75,7 +75,6 @@ public:
* the selection.
*
* @param shape the shape to add to the selection
* @param recursive enables recursively selecting shapes of parent groups
*/
void select(KoShape *shape);
......@@ -91,7 +90,6 @@ public:
* from the selection.
*
* @param shape the shape to remove from the selection
* @param recursive enables recursively deselecting shapes of parent groups
*/
void deselect(KoShape *shape);
......@@ -124,8 +122,6 @@ public:
/**
* Return the first selected shape, or 0 if there is nothing selected.
* @param strip if StrippedSelection, the returned list will not include any children
* of a grouped shape if the group-parent is itself also in the set.
*/
KoShape *firstSelectedShape() const;
......
......@@ -412,7 +412,7 @@ public:
/**
* Set the side text should flow around this shape.
* @param side the requested side
* @param runThrought run through the foreground or background or...
* @param runThrough run through the foreground or background or...
*/
void setTextRunAroundSide(TextRunAroundSide side, RunThroughLevel runThrough = Background);
......@@ -505,7 +505,7 @@ public:
/**
* Set the minimum height of the shape.
* Currently it's not respected but only for informational purpose
* @param minimumShapeHeight the minimum height of the frame.
* @param height the minimum height of the frame.
*/
void setMinimumHeight(qreal height);
......
......@@ -89,7 +89,8 @@ public:
/**
* @brief Add shapes to the document, skipping any dialogs or other user interaction.
*
* @param shapes to add to the document
* @param shape the shape to add to the document
* @param parentShape the parent shape
* @param parent the parent command if the resulting command is a compound undo command.
*
* @return command which will insert the shapes into the document. The command is not yet executed.
......
......@@ -56,7 +56,7 @@ public:
* Add shapes to the shape controller, allowing it to be seen and saved.
* The controller should add the shape to the ShapeManager instance(s) manually
* if the shape is one that should be currently shown on screen.
* @param shape the new shape
* @param shapes the shapes to add
*/
virtual void addShapes(const QList<KoShape*> shapes) = 0;
......
......@@ -276,7 +276,6 @@ Q_SIGNALS:
/**
* Emitted after the selection changed to state which unique shape-types are now
* in the selection.
* @param canvas the currently active canvas.
* @param types a list of string that are the shape types of the selected objects.
*/
void toolCodesSelected(const QList<QString> &types);
......
......@@ -43,8 +43,8 @@ public:
* The createCommand will make sure that the group will have the z-index and the parent of the top most shape in the group.
*
* @param container the group to group the shapes under.
* @param parent the parent command if the resulting command is a compound undo command.
* @param shapes a list of all the shapes that should be grouped.
* @param shouldNormalize whether the shapes should be normalized
*/
static KoShapeGroupCommand *createCommand(KoShapeContainer *container, const QList<KoShape *> &shapes, bool shouldNormalize = false);
......@@ -52,10 +52,7 @@ public:
* Command to group a set of shapes into a predefined container.
* @param container the container to group the shapes under.
* @param shapes a list of all the shapes that should be grouped.
* @param clipped shows whether the shapes should be clipped by the container
* See KoShapeContainer::isClipped()
* @param inheritTransform shows whether the shapes should inherit the parent transformation
* See KoShapeContainer::inheritsTransform()
* @param shouldNormalize shows whether the shapes should be normalized by the container
* @param parent the parent command used for macro commands
*/
KoShapeGroupCommand(KoShapeContainer *container, const QList<KoShape *> &shapes, bool shouldNormalize, KUndo2Command *parent = 0);
......
......@@ -53,7 +53,7 @@ public:
/**
* Parses the given string containing a percentage number.
* @param s the input string containing the percentage
* @param value the input number containing the percentage
* @return the percentage number normalized to 0..100
*/
static QString toPercentage(qreal value);
......
......@@ -255,12 +255,14 @@ void addParamNode(QDomDocument& doc,
void KisMultiChannelFilterConfiguration::toXML(QDomDocument& doc, QDomElement& root) const
{
/**
* @code
* <params version=1>
* <param name="nTransfers">3</param>
* <param name="curve0">0,0;0.5,0.5;1,1;</param>
* <param name="curve1">0,0;1,1;</param>
* <param name="curve2">0,0;1,1;</param>
* </params>
* @endcode
*/
root.setAttribute("version", version());
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment