Commit e8064685 authored by Yuri Chornoivan's avatar Yuri Chornoivan

Fix minor Doxygen issues

parent 52528f6a
......@@ -37,9 +37,10 @@ public:
* Command for layer moves inside the layer stack
*
* @param image the image
* @param layer the moved layer
* @param node the moved node
* @param newParent the next parent of the layer
* @param newAbove the layer that will be below the layer after the move
* @param doUpdates whether to do updates
*/
KisImageLayerMoveCommand(KisImageWSP image, KisNodeSP node, KisNodeSP newParent, KisNodeSP newAbove, bool doUpdates = true);
KisImageLayerMoveCommand(KisImageWSP image, KisNodeSP node, KisNodeSP newParent, quint32 index);
......
......@@ -52,11 +52,14 @@ public:
public:
/**
* This function creates an auto brush shape with the following value :
* @param w width
* @param h height
* @param fh horizontal fade (fh \< w / 2 )
* @param fv vertical fade (fv \< h / 2 )
* This function creates an auto brush shape with the following values:
* @param radius radius
* @param ratio aspect ratio
* @param fh horizontal fade
* @param fv vertical fade
* @param spikes number of spikes
* @param antialiasEdges whether to antialias edges
* @param id the brush identifier
*/
KisMaskGenerator(qreal radius, qreal ratio, qreal fh, qreal fv, int spikes, bool antialiasEdges, Type type, const KoID& id = DefaultId);
KisMaskGenerator(const KisMaskGenerator &rhs);
......
......@@ -284,7 +284,11 @@ public:
* paint device. If the specified area is larger than the paint
* device's extent, the default pixel will be read.
*
* @param channelsize a vector with for every channel its size in bytes
* @param channelsizes a vector with for every channel its size in bytes
* @param x x coordinate of the top left corner
* @param y y coordinate of the top left corner
* @param w width
* @param h height
*/
QVector<quint8*> readPlanarBytes(QVector<qint32> channelsizes, qint32 x, qint32 y, qint32 w, qint32 h) const {
return ACTUAL_DATAMGR::readPlanarBytes(channelsizes, x, y, w, h);
......@@ -302,8 +306,12 @@ public:
* read. Krita may also crash.
*
* @param planes a vector with a byte array for every plane
* @param channelsize a vector with for every channel its size in
* @param channelsizes a vector with for every channel its size in
* bytes
* @param x x coordinate of the top left corner
* @param y y coordinate of the top left corner
* @param w width
* @param h height
*
* XXX: what about undo?
*/
......
......@@ -201,7 +201,7 @@ public:
m_sizemod = sizemod;
}
/** Sets how much to auto-grow or shrink (if @param sizemod is negative) the selection
/** Sets how much to auto-grow or shrink (if @p sizemod is negative) the selection
flood before painting, this affects every fill operation except fillRect */
int sizemod() {
return m_sizemod;
......
......@@ -79,7 +79,7 @@ class KRITAIMAGE_EXPORT KisImage : public QObject,
public:
/// @param colorSpace can be null. in that case it will be initialised to a default color space.
/// @p colorSpace can be null. In that case, it will be initialised to a default color space.
KisImage(KisUndoStore *undoStore, qint32 width, qint32 height, const KoColorSpace *colorSpace, const QString& name);
~KisImage() override;
......@@ -254,6 +254,7 @@ public:
* The method will **drop** all the layer data outside \p newRect. Neither
* image nor a layer will be moved anywhere
*
* @param node node to crop
* @param newRect the rectangle of the layer which will be cut-out
*
* Please note that the actual operation starts asynchronously in
......@@ -278,8 +279,11 @@ public:
/**
* @brief start asynchronous operation on scaling a subtree of nodes starting at \p node
* @param node node to scale
* @param scaleX, @param scaleY scale coefficient to be applied to the node
* @param center the center of the scaling
* @param scaleX x-scale coefficient to be applied to the node
* @param scaleY y-scale coefficient to be applied to the node
* @param filterStrategy filtering strategy
* @param selection the selection we based on
*
* Please note that the actual operation starts asynchronously in
* a background, so you cannot expect the image having new size
......@@ -307,6 +311,7 @@ public:
*
* @param node the root of the subtree to rotate
* @param radians rotation angle in radians
* @param selection the selection we based on
*
* Please note that the actual operation starts asynchronously in
* a background, so you cannot expect the operation being completed
......@@ -319,7 +324,7 @@ public:
*
* The image is resized to fit the sheared polygon
*
* @param angleX, @param angleY are given in degrees.
* @p angleX, @p angleY are given in degrees.
*
* Please note that the actual operation starts asynchronously in
* a background, so you cannot expect the operation being completed
......@@ -333,7 +338,9 @@ public:
* The image is not resized!
*
* @param node the root of the subtree to rotate
* @param angleX, @param angleY are given in degrees.
* @param angleX x-shear given in degrees.
* @param angleY y-shear given in degrees.
* @param selection the selection we based on
*
* Please note that the actual operation starts asynchronously in
* a background, so you cannot expect the operation being completed
......@@ -352,7 +359,7 @@ public:
* Set the color space of the projection (and the root layer)
* to dstColorSpace. No conversion is done for other layers,
* their colorspace can differ.
* NOTE: Note conversion is done, only regeneration, so no rendering
* @note No conversion is done, only regeneration, so no rendering
* intent needed
*/
void convertProjectionColorSpace(const KoColorSpace *dstColorSpace);
......
......@@ -495,7 +495,7 @@ public:
/**
* Fill this paint device with the data from image; starting at (offsetX, offsetY)
* @param srcProfileName name of the RGB profile to interpret the image as. 0 is interpreted as sRGB
* @param profile name of the RGB profile to interpret the image as. 0 is interpreted as sRGB
*/
void convertFromQImage(const QImage& image, const KoColorProfile *profile, qint32 offsetX = 0, qint32 offsetY = 0);
......@@ -539,9 +539,10 @@ public:
* the aspect ratio. The width and height of the returned device
* won't exceed \p maxw and \p maxw, but they may be smaller.
*
* @param maxw: maximum width
* @param maxh: maximum height
* @param rect: only this rect will be used for the thumbnail
* @param w maximum width
* @param h maximum height
* @param rect only this rect will be used for the thumbnail
* @param outputRect output rectangle
*
*/
KisPaintDeviceSP createThumbnailDevice(qint32 w, qint32 h, QRect rect = QRect(), QRect outputRect = QRect()) const;
......@@ -720,7 +721,6 @@ public:
/**
* Create a keyframe channel for the content on this device.
* @param id identifier for the channel
* @param node the parent node for the channel
* @return keyframe channel or 0 if there is not one
*/
KisRasterKeyframeChannel *createKeyframeChannel(const KoID &id);
......@@ -786,20 +786,19 @@ public:
* Create an iterator that will "artificially" extend the paint device with the
* value of the border when trying to access values outside the range of data.
*
* @param rc indicates the rectangle that truly contains data
* @param _dataWidth indicates the rectangle that truly contains data
*/
KisRepeatHLineConstIteratorSP createRepeatHLineConstIterator(qint32 x, qint32 y, qint32 w, const QRect& _dataWidth) const;
/**
* Create an iterator that will "artificially" extend the paint device with the
* value of the border when trying to access values outside the range of data.
*
* @param rc indicates the rectangle that truly contains data
* @param _dataWidth indicates the rectangle that truly contains data
*/
KisRepeatVLineConstIteratorSP createRepeatVLineConstIterator(qint32 x, qint32 y, qint32 h, const QRect& _dataWidth) const;
/**
* This function create a random accessor which can easily access to sub pixel values.
* @param selection an up-to-date selection that has the same origin as the paint device
*/
KisRandomSubAccessorSP createRandomSubAccessor() const;
......
......@@ -60,16 +60,16 @@ public:
/**
* Copy the given paint device contents into the specified frame
* @param dstFrameId ID of the frame to be overwritten (must exist)
* @param srcFrameId ID of the frame to copy from (must exist)
* @param sourceDevice paint device to copy from
* @param dstFrameId ID of the frame to be overwritten (must exist)
* @param srcDevice paint device to copy from
*/
void uploadFrame(int srcFrameId, int dstFrameId, KisPaintDeviceSP srcDevice);
/**
* Copy the given paint device contents into the specified frame
* @param dstFrameId ID of the frame to be overwritten (must exist)
* @param sourceDevice paint device to copy from
* @param srcDevice paint device to copy from
*/
void uploadFrame(int dstFrameId, KisPaintDeviceSP srcDevice);
......
......@@ -191,10 +191,10 @@ public:
/**
* Convenience method that uses QPoint and QRect.
*
* @param pos the destination coordinate, it replaces @param dstX and @param dstY.
* @param pos the destination coordinate, it replaces @p dstX and @p dstY.
* @param srcDev the source device.
* @param srcRect the rectangle describing the area to blast from @param srcDev into the current paint device.
* @param srcRect replaces @param srcX, @param srcY, @param srcWidth and @param srcHeight.
* @param srcRect the rectangle describing the area to blast from @p srcDev into the current paint device.
* @p srcRect replaces @p srcX, @p srcY, @p srcWidth and @p srcHeight.
*
*/
void bitBlt(const QPoint & pos, const KisPaintDeviceSP srcDev, const QRect & srcRect);
......@@ -218,10 +218,10 @@ public:
/**
* Convenience method that uses QPoint and QRect.
*
* @param pos the destination coordinate, it replaces @param dstX and @param dstY.
* @param pos the destination coordinate, it replaces @p dstX and @p dstY.
* @param srcDev the source device.
* @param srcRect the rectangle describing the area to blast from @param srcDev into the current paint device.
* @param srcRect replaces @param srcX, @param srcY, @param srcWidth and @param srcHeight.
* @p srcRect replaces @p srcX, @p srcY, @p srcWidth and @p srcHeight.
*
*/
void bitBltOldData(const QPoint & pos, const KisPaintDeviceSP srcDev, const QRect & srcRect);
......@@ -261,8 +261,8 @@ public:
qint32 srcWidth, qint32 srcHeight);
/**
* Convenience method that assumes @param selX, @param selY, @param srcX and @param srcY are
* equal to 0. Best used when @param selection and the desired area of @param srcDev have exactly
* Convenience method that assumes @p selX, @p selY, @p srcX and @p srcY are
* equal to 0. Best used when @p selection and the desired area of @p srcDev have exactly
* the same dimensions and are specially made for each other.
*
* @param dstX the destination x-coordinate
......@@ -308,10 +308,10 @@ public:
/**
* Convenience method that uses QPoint and QRect.
*
* @param pos the destination coordinate, it replaces @param dstX and @param dstY.
* @param pos the destination coordinate, it replaces @p dstX and @p dstY.
* @param srcDev the source device.
* @param srcRect the rectangle describing the area to blast from @param srcDev into the current paint device.
* @param srcRect replaces @param srcX, @param srcY, @param srcWidth and @param srcHeight.
* @param srcRect the rectangle describing the area to blast from @p srcDev into the current paint device.
* @param srcRect replaces @p srcX, @p srcY, @p srcWidth and @p srcHeight.
*
*/
void bltFixed(const QPoint & pos, const KisFixedPaintDeviceSP srcDev, const QRect & srcRect);
......@@ -352,8 +352,8 @@ public:
quint32 srcWidth, quint32 srcHeight);
/**
* Convenience method that assumes @param selX, @param selY, @param srcX and @param srcY are
* equal to 0. Best used when @param selection and @param srcDev have exactly the same
* Convenience method that assumes @p selX, @p selY, @p srcX and @p srcY are
* equal to 0. Best used when @p selection and @p srcDev have exactly the same
* dimensions and are specially made for each other.
*
* @param dstX the destination x-coordinate
......@@ -369,8 +369,8 @@ public:
quint32 srcWidth, quint32 srcHeight);
/**
* fills a region of width @param width and height @param height of the current
* paint device with the color @param color. @param x and @param y set the x and y positions of the
* fills a region of width @p width and height @p height of the current
* paint device with the color @p color. @p x and @p y set the x and y positions of the
* origin top-left corner.
*
* @param x the destination x-coordinate
......@@ -542,7 +542,8 @@ public:
/**
* Fills the portion of an area enclosed by the given QPainterPath
*
* \param rect the portion of the path to fill
* \param path the portion of the path to fill
* \param requestedRect the rectangle containing the area
*/
void fillPainterPath(const QPainterPath& path, const QRect &requestedRect);
......@@ -592,7 +593,7 @@ public:
/**
* Paint an unstroked wide line from the specified start to the specified
* end position with width varying from @param w1 at the start to @param w2 at
* end position with width varying from @p start at the start to @p end at
* the end.
*
* XXX: the width should be set in doubles, not integers.
......@@ -607,7 +608,7 @@ public:
* An empty channelFlags parameter means that all channels are
* affected.
*
* @param the bit array that masks the source channels; only
* @param channelFlags the bit array that masks the source channels; only
* the channels where the corresponding bit is true will will be
* composited onto the destination device.
*/
......@@ -617,7 +618,7 @@ public:
QBitArray channelFlags();
/**
* Set the paintop preset to use. If @param image is given,
* Set the paintop preset to use. If @p image is given,
* the paintop will be created using this image as parameter.
* Some paintops really want to know about the image they work
* for, e.g. the clone paintop.
......
......@@ -42,7 +42,7 @@ public:
friend class KisRepeatHLineIteratorPixelBase<T>;
friend class KisRepeatVLineIteratorPixelBase<T>;
/**
* @param rc indicates the rectangle that truly contains data
* @param _rc indicates the rectangle that truly contains data
*/
inline KisRepeatLineIteratorPixelBase(KisDataManager *dm, qint32 x, qint32 y, qint32 offsetx, qint32 offsety, const QRect& _rc, KisIteratorCompleteListener *completeListener);
virtual inline ~KisRepeatLineIteratorPixelBase();
......@@ -75,7 +75,7 @@ class KisRepeatHLineIteratorPixelBase : public KisRepeatLineIteratorPixelBase<T>
{
public:
/**
* @param rc indicates the rectangle that truly contains data
* @param _rc indicates the rectangle that truly contains data
*/
inline KisRepeatHLineIteratorPixelBase(KisDataManager *dm, qint32 x, qint32 y, qint32 w, qint32 offsetx, qint32 offsety, const QRect& _rc, KisIteratorCompleteListener *completeListener);
inline ~KisRepeatHLineIteratorPixelBase() override;
......@@ -101,7 +101,7 @@ class KisRepeatVLineIteratorPixelBase : public KisRepeatLineIteratorPixelBase<T>
{
public:
/**
* @param rc indicates the rectangle that truly contains data
* @param _rc indicates the rectangle that truly contains data
*/
inline KisRepeatVLineIteratorPixelBase(KisDataManager *dm, qint32 x, qint32 y, qint32 h, qint32 offsetx, qint32 offsety, const QRect& _rc, KisIteratorCompleteListener *completeListener);
inline ~KisRepeatVLineIteratorPixelBase() override;
......
......@@ -80,7 +80,7 @@ public:
* Offset the specified device with wrapping around edges of rect specified as QRect(0,0,wrapSize.width, wrapSize.height)*
* @param device device to be offset
* @param offsetPosition position where the new origin will be
* @param wrapSize width and height of the wrap edge, usual scenario is to use canvas width&height
* @param wrapRect width and height of the wrap edge, usual scenario is to use canvas width&height
*
**/
static void offset(KisPaintDeviceSP device, const QPoint &offsetPosition, const QRect &wrapRect);
......
......@@ -30,7 +30,7 @@ class KRITAIMAGE_EXPORT KisMemoryWindow
{
public:
/**
* @param swapDir. If the dir doesn't exist, it'll be created, if it's empty QDir::tempPath will be used.
* @param swapDir If the dir doesn't exist, it'll be created, if it's empty QDir::tempPath will be used.
*/
KisMemoryWindow(const QString &swapDir, quint64 writeWindowSize = DEFAULT_WINDOW_SIZE);
~KisMemoryWindow();
......
......@@ -50,7 +50,7 @@ public Q_SLOTS:
qreal zoomLevel() const;
/**
* @brief setZoomLevel set the zoomlevel to the given @param value. 1.0 is 100%.
* @brief setZoomLevel set the zoomlevel to the given @p value. 1.0 is 100%.
*/
void setZoomLevel(qreal value);
......
......@@ -45,8 +45,8 @@ public:
/**
* @brief CloneLayer
* function for wrapping a preexisting node into a clonelayer object.
* @param clone
* @param parent
* @param layer the clone layer
* @param parent the parent QObject
*/
explicit CloneLayer(KisCloneLayerSP layer, QObject *parent = 0);
~CloneLayer() override;
......
......@@ -92,7 +92,7 @@ public Q_SLOTS:
bool batchmode() const;
/**
* Set batchmode to @param value. If batchmode is true, then there should be no popups
* Set batchmode to @p value. If batchmode is true, then there should be no popups
* or dialogs shown to the user.
*/
void setBatchmode(bool value);
......@@ -282,12 +282,12 @@ public Q_SLOTS:
void setHeight(int value);
/**
* @return the name of the document. This is the title field in the @see documentInfo
* @return the name of the document. This is the title field in the @ref documentInfo
*/
QString name() const;
/**
* @brief setName sets the name of the document to @param value. This is the title field in the @see documentInfo
* @brief setName sets the name of the document to @p value. This is the title field in the @ref documentInfo
*/
void setName(QString value);
......@@ -336,7 +336,7 @@ public Q_SLOTS:
int xOffset() const;
/**
* @brief setXOffset sets the left edge of the canvas to @param x.
* @brief setXOffset sets the left edge of the canvas to @p x.
*/
void setXOffset(int x);
......@@ -346,7 +346,7 @@ public Q_SLOTS:
int yOffset() const;
/**
* @brief setYOffset sets the top edge of the canvas to @param y.
* @brief setYOffset sets the top edge of the canvas to @p y.
*/
void setYOffset(int y);
......@@ -521,8 +521,8 @@ public Q_SLOTS:
bool save();
/**
* @brief saveAs save the document under the @param filename. The document's
* filename will be reset to @param filename.
* @brief saveAs save the document under the @p filename. The document's
* filename will be reset to @p filename.
* @param filename the new filename (full path) for the document
* @return true if saving succeeded, false otherwise.
*/
......@@ -711,13 +711,13 @@ print(root.childNodes())
/**
* @brief setHorizontalGuides
* replace all existing horizontal guides with the entries in the list.
* @param list a list of floats containing the new guides.
* @param lines a list of floats containing the new guides.
*/
void setHorizontalGuides(const QList<qreal> &lines);
/**
* @brief setVerticalGuides
* replace all existing horizontal guides with the entries in the list.
* @param list a list of floats containing the new guides.
* @param lines a list of floats containing the new guides.
*/
void setVerticalGuides(const QList<qreal> &lines);
......
......@@ -65,7 +65,7 @@ public:
/**
* Create a new extension. The extension will be
* owned by @param parent.
* owned by @p parent.
*/
explicit Extension(QObject *parent = 0);
~Extension() override;
......
......@@ -49,9 +49,9 @@ public:
QMap<QString, QVariant> properties() const;
/**
* Add all properties in the @param propertyMap to this InfoObject
* Add all properties in the @p propertyMap to this InfoObject
*/
void setProperties(QMap<QString, QVariant> proprertyMap);
void setProperties(QMap<QString, QVariant> propertyMap);
public Q_SLOTS:
/**
......
......@@ -181,7 +181,7 @@ public:
* Unserialize a color following Create's swatch color specification available
* at http://create.freedesktop.org/wiki/index.php/Swatches_-_colour_file_format
*
* @param XXX
* @param xml an XML color
*
* @return the unserialized color, or an empty color object if the function failed
* to unserialize the color
......@@ -190,7 +190,6 @@ public:
/**
* @brief toQString create a user-visible string of the channel names and the channel values
* @param color the color to create the string from
* @return a string that can be used to display the values of this color to the user.
*/
QString toQString();
......
......@@ -136,7 +136,7 @@ public:
void addEntry(Swatch entry, QString groupName = QString());
/**
* @brief removeEntry
* remove the entry at @param index from the group @param groupName.
* remove the entry at @p index from the group @p groupName.
*/
void removeEntry(int index, const QString &groupName);
......
......@@ -91,7 +91,7 @@ public Q_SLOTS:
* propertize the action if any .action file is present
* @param text The user-visible text of the action. If empty, the text from the
* .action file is used.
* @param menu a /-separated string that describes which menu the action should
* @param menuLocation a /-separated string that describes which menu the action should
* be places in. Default is "tools/scripts"
* @return the new action.
*/
......
......@@ -104,7 +104,7 @@ public:
/**
* @brief saveOdf saves this element reference into the currently open element in the xml writer.
* @param writer the writer we save to
* @param saveOptions determines which attributes we save. We always save the xml:id.
* @param saveOption determines which attributes we save. We always save the xml:id.
*/
void saveOdf(KoXmlWriter *writer, SaveOption saveOption = XmlId) const;
......
......@@ -67,7 +67,7 @@ public:
/**
* assignment operator to copy the data from the param color into this one.
* @param other the color we are going to copy
* @param rhs the color we are going to copy
* @return this color
*/
inline KoColor &operator=(const KoColor &rhs) {
......
......@@ -380,16 +380,10 @@ public:
quint8 *gamutWarning, double adaptationState) const;
/**
* @brief proofPixelsTo
* @param src
* @param dst
* @param dstColorSpace the colorspace to which we go to.
* @param proofingSpace the proofing space.
* @param src source
* @param dst destination
* @param numPixels the amount of pixels.
* @param renderingIntent the rendering intent used for rendering.
* @param proofingIntent the intent used for proofing.
* @param conversionFlags the conversion flags.
* @param gamutWarning the data() of a KoColor.
* @param adaptationState the state of adaptation, only affects absolute colorimetric.
* @param proofingTransform the intent used for proofing.
* @return
*/
virtual bool proofPixelsTo(const quint8 * src,
......@@ -543,9 +537,11 @@ public:
* colorspace.
*
* @param srcSpace the colorspace of the source pixels that will be composited onto "us"
* @param param the information needed for blitting e.g. the source and destination pixel data,
* @param params the information needed for blitting e.g. the source and destination pixel data,
* the opacity and flow, ...
* @param op the composition operator to use, e.g. COPY_OVER
* @param renderingIntent the rendering intent
* @param conversionFlags the conversion flags.
*
*/
virtual void bitBlt(const KoColorSpace* srcSpace, const KoCompositeOp::ParameterInfo& params, const KoCompositeOp* op,
......
......@@ -72,38 +72,38 @@ public /* methods */:
/**
* @brief checkEntry
* checks if position x and y has a valid entry
* both x and y start from 0
* @param x
* @param y
* @return true if there is a valid entry at position (x, y)
* checks if position @p column and @p row has a valid entry
* both @p column and @p row start from 0
* @param column
* @param row
* @return true if there is a valid entry at position (column, row)
*/
bool checkEntry(int column, int row) const;
/**
* @brief setEntry
* sets the entry at position (x, y) to be e
* sets the entry at position (@p column, @p row) to be @p e
* @param e
* @param x
* @param y
* @param column
* @param row
*/
void setEntry(const KisSwatch &e, int column, int row);
/**
* @brief getEntry
* used to get the swatch entry at position (x, y)
* used to get the swatch entry at position (@p column, @p row)
* there is an assertion to make sure that this position isn't empty,
* so checkEntry(int, int) must be used before this method to ensure
* a valid entry can be found
* @param x
* @param y
* @return the swatch entry at position (x, y)
* @param column
* @param row
* @return the swatch entry at position (column, row)
*/
KisSwatch getEntry(int column, int row) const;
/**
* @brief removeEntry
* removes the entry at position (x, y)
* @param x
* @param y
* @return true if these is an entry at (x, y)
* removes the entry at position (@p column, @p row)
* @param column
* @param row
* @return true if these is an entry at (column, row)
*/
bool removeEntry(int column, int row);
/**
......
......@@ -137,8 +137,9 @@ public /* methods */:
/**
* @brief getColorGlobal
* A function for getting a color based on a global index. Useful for itterating through all color entries.
* @param globalIndex the global index over the whole palette.
* A function for getting a color based on a global index. Useful for iterating through all color entries.
* @param x the global x index over the whole palette.
* @param y the global y index over the whole palette.
* @return the entry.
*/
KisSwatch getColorGlobal(quint32 x, quint32 y) const;
......@@ -146,8 +147,9 @@ public /* methods */:
/**
* @brief getColorGroup
* A function for getting the color from a specific group.
* @param groupName the name of the group, will give unosrted when not defined.
* @param index the index within the group.
* @param x the x index over the group.
* @param y the y index over the group.
* @param groupName the name of the group, will give unsorted when not defined.
* @return the entry
*/
KisSwatch getColorGroup(quint32 x, quint32 y, QString groupName);
......@@ -201,7 +203,7 @@ public /* methods */:
* @brief getIndexClosestColor
* function that matches the color to all colors in the colorset, and returns the index
* of the closest match.
* @param color the color you wish to compare.
* @param compare the color you wish to compare.
* @param useGivenColorSpace whether to use the color space of the color given
* when the two colors' colorspaces don't match. Else it'll use the entry's colorspace.
* @return returns the int of the closest match.
......
......@@ -48,7 +48,7 @@ public:
/**
* Conversion routine
* @param _internalNaming name used internally : "root", "tar:/0", ...
* @param internalNaming name used internally : "root", "tar:/0", ...
* @return the name used in the file, more user-friendly ("maindoc.xml",
* "part0/maindoc.xml", ...)
* Examples:
......
......@@ -42,8 +42,9 @@ class KisOpenPane : public QDialog
public:
/**
* Constructor
* @param parent the parent widget
* @param templateType the template-type (group) that should be selected on creation.
* @param parent the parent widget.
* @param mimeType the template-type (group) that should be selected on creation.
* @param templatesResourcePath the path to the templates.
*/
KisOpenPane(QWidget *parent, const QStringList& mimeFilter, const QString& templatesResourcePath = QString());
~KisOpenPane() override;
......
......@@ -70,7 +70,7 @@ public:
QString oldNameFromNewName(const QString &newName) const;
/**
* @brief duplicateExistsFilename
* @param name
* @param filename the name of the file
* @param global if this filename is going to be used for a global palette
* @return true if the a palette in the resource system that has filename
* name already exists else false
......@@ -84,9 +84,7 @@ public:
/**
* @brief addGroup
* @param name original group name
* @param rowNumber
* @return new group's name if change accpeted, empty string if cancelled
* @return new group's name if change accepted, empty string if cancelled
*/
QString addGroup();
/**
......
......@@ -44,7 +44,7 @@ class KRITAUI_EXPORT KisPrintJob : public QObject
public:
/**
* Constructor.
* @param parent the parent qobject that is passed for memory management purposes.
* @param image the image that is passed for management purposes.
*/
explicit KisPrintJob(KisImageWSP image);
~KisPrintJob() override;
......
......@@ -41,7 +41,8 @@ class KRITAUI_EXPORT KisResourceBundle : public KoResource
public:
/**
* @brief ResourceBundle : Ctor * @param bundlePath the path of the bundle
* @brief ResourceBundle : Ctor *
* @param bundlePath the path of the bundle
*/
KisResourceBundle(QString const& fileName);
......
......@@ -48,7 +48,6 @@ public:
/**
* @brief ResourceBundleManifest : Ctor
* @param xmlName the name of the XML file to be created
*/
KisResourceBundleManifest();
......@@ -72,7 +71,8 @@ public:
* @brief addTag : Add a file tag as a child of the fileType tag.
* @param fileType the type of the file to be added
* @param fileName the name of the file to be added
* @param emptyFile true if the file is empty
* @param tagFileList list of the tags
* @param md5 MD5 checksum