Commit bc91c050 authored by Jan Hambrecht's avatar Jan Hambrecht

apidoc fixes

svn path=/trunk/koffice/; revision=824038
parent 8adb3f0c
...@@ -318,12 +318,13 @@ public: ...@@ -318,12 +318,13 @@ public:
/** /**
* Set the background of the shape. * Set the background of the shape.
* A QBrush can have a plain color, be fully transparent or have a complex fill. * A shape background can be a plain color, a gradient, a pattern, be fully transparent
* setting such a brush will allow the shape to fill itself using that brush and * or have a complex fill.
* will be able to tell if its transparent or not. * Setting such a background will allow the shape to be filled and will be able to tell
* @param brush the brush for the background. * if it is transparent or not.
* @param background the new shape background.
*/ */
void setBackground ( KoShapeBackground * bg ); void setBackground ( KoShapeBackground * background );
/** /**
* return the brush used to paint te background of this shape with. * return the brush used to paint te background of this shape with.
* A QBrush can have a plain color, be fully transparent or have a complex fill. * A QBrush can have a plain color, be fully transparent or have a complex fill.
......
...@@ -38,10 +38,10 @@ public: ...@@ -38,10 +38,10 @@ public:
/** /**
* Writes the style of the brush using the internal saving context * Writes the style of the brush using the internal saving context
* @param style the style to write to * @param style the style to write to
* @param brush the fill style to save * @param fill the fill style to save
* @return the name of the saved style * @return the name of the saved style
*/ */
QString addFillStyle( KoGenStyle &style, const QBrush &brush ); QString addFillStyle( KoGenStyle &style, const QBrush &fill );
/** /**
* Add the fill style to the current style * Add the fill style to the current style
...@@ -50,7 +50,7 @@ public: ...@@ -50,7 +50,7 @@ public:
* to the styles collection * to the styles collection
* *
* @param style the style to write to * @param style the style to write to
* @param brush the fill style to save * @param fill the fill style to save
*/ */
void saveFillStyle( KoGenStyle &style, const QBrush &fill ); void saveFillStyle( KoGenStyle &style, const QBrush &fill );
......
...@@ -33,7 +33,7 @@ public: ...@@ -33,7 +33,7 @@ public:
/** /**
* Command to set a new shape background. * Command to set a new shape background.
* @param shapes a set of all the path shapes that should get the new fill rule * @param shapes a set of all the path shapes that should get the new fill rule
* @param fillrule the new fill rule * @param fillRule the new fill rule
* @param parent the parent command used for macro commands * @param parent the parent command used for macro commands
*/ */
KoPathFillRuleCommand( const QList<KoPathShape*> &shapes, Qt::FillRule fillRule, QUndoCommand *parent = 0 ); KoPathFillRuleCommand( const QList<KoPathShape*> &shapes, Qt::FillRule fillRule, QUndoCommand *parent = 0 );
......
...@@ -36,7 +36,7 @@ public: ...@@ -36,7 +36,7 @@ public:
/** /**
* Command to set a new shape background. * Command to set a new shape background.
* @param shapes a set of all the shapes that should get the new background. * @param shapes a set of all the shapes that should get the new background.
* @param brush the new background brush * @param fill the new shape background
* @param parent the parent command used for macro commands * @param parent the parent command used for macro commands
*/ */
KoShapeBackgroundCommand( const QList<KoShape*> &shapes, KoShapeBackground * fill, QUndoCommand *parent = 0 ); KoShapeBackgroundCommand( const QList<KoShape*> &shapes, KoShapeBackground * fill, QUndoCommand *parent = 0 );
...@@ -44,7 +44,7 @@ public: ...@@ -44,7 +44,7 @@ public:
/** /**
* Command to set a new shape background. * Command to set a new shape background.
* @param shape a single shape that should get the new background. * @param shape a single shape that should get the new background.
* @param brush the new background brush * @param fill the new shape background
* @param parent the parent command used for macro commands * @param parent the parent command used for macro commands
*/ */
KoShapeBackgroundCommand( KoShape * shape, KoShapeBackground * fill, QUndoCommand *parent = 0 ); KoShapeBackgroundCommand( KoShape * shape, KoShapeBackground * fill, QUndoCommand *parent = 0 );
......
...@@ -50,7 +50,7 @@ public: ...@@ -50,7 +50,7 @@ public:
/** /**
* Command to set a new shape border. * Command to set a new shape border.
* @param shapes a single shape that should get the new border. * @param shape a single shape that should get the new border.
* @param border the new border * @param border the new border
* @param parent the parent command used for macro commands * @param parent the parent command used for macro commands
*/ */
......
...@@ -49,7 +49,7 @@ public: ...@@ -49,7 +49,7 @@ public:
/** /**
* Command to set a new shape shadow. * Command to set a new shape shadow.
* @param shapes a single shape that should get the new shadow. * @param shape a single shape that should get the new shadow.
* @param shadow the new shadow * @param shadow the new shadow
* @param parent the parent command used for macro commands * @param parent the parent command used for macro commands
*/ */
......
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