Commit 5fe95d19 authored by Yuri Chornoivan's avatar Yuri Chornoivan

Fix minor Doxygen issues

parent 91430816
......@@ -32,7 +32,7 @@ class KoSvgTextChunkShapeLayoutInterface;
/**
* KoSvgTextChunkShape is an elementary block of SVG text object.
*
* KoSvgTextChunkShape represents either a <tspan> or <text> element of SVG.
* KoSvgTextChunkShape represents either a \<tspan\> or \<text\> element of SVG.
* The chunk shape uses flake hierarchy to represent the DOM hierarchy of the
* supplied text. All the attributes of text blocks can be fetched using
* textProperties() method.
......@@ -49,8 +49,8 @@ class KoSvgTextChunkShapeLayoutInterface;
* KoSvgTextChunkShape! The chunk shape is **not** a "text chunk" in SVG's
* definition. According to SVG, "text chunk" is a set of characters anchored to
* a specific absolute position on canvas. And KoSvgTextChunkShape is just one
* <tspan> or <text> element. Obviously, one <tspan> can contain multiple "text
* chunks" and, vice versa, a "text chunk" can spread onto multiple <span>'s.
* \<tspan\> or \<text\> element. Obviously, one \<tspan\> can contain multiple "text
* chunks" and, vice versa, a "text chunk" can spread onto multiple \<span\>'s.
*/
class KRITAFLAKE_EXPORT KoSvgTextChunkShape : public KoShapeContainer, public SvgShape
{
......@@ -131,7 +131,7 @@ public:
* itself, of an "intermediate chunk" that doesn't contain any text itself,
* but works as a group for a set of child chunks, which might be either
* text (leaf) or intermediate chunks. Such groups are needed to define a
* common text style for a group of '<tspan>' objects.
* common text style for a group of '\<tspan\>' objects.
*
* @return true if the chunk is a "text chunk" false if it is "intermediate chunk"
*/
......
......@@ -38,7 +38,7 @@ class SvgLoadingContext;
* the properties of the two shapes and distinguish, which properties were
* inherited by text shape, and which are its own. It is needed to generate a
* correct and clean SVG/markup code that can be edited by the user easily.
* Otherwise, every <tspan> block will contain the full list of 20+ attributes,
* Otherwise, every \<tspan\> block will contain the full list of 20+ attributes,
* which are not interesting for the user, since they are inherited or default.
*
* To achieve the goal, KoSvgTextProperties wraps all the SVG attributes into a
......@@ -129,7 +129,7 @@ public:
/**
* Reset all non-inheritable properties to default values. The set of
* non-inheritable properties is define by SVG 1.1. Used by the loading
* code for resetting state automata's properties on entering a <tspan>.
* code for resetting state automata's properties on entering a \<tspan\>.
*/
void resetNonInheritableToDefault();
......
......@@ -30,7 +30,7 @@ class KoSvgTextShapePrivate;
#define KoSvgTextShape_SHAPEID "KoSvgTextShapeID"
/**
* KoSvgTextShape is a root chunk of the <text> element subtree.
* KoSvgTextShape is a root chunk of the \<text\> element subtree.
*/
class KRITAFLAKE_EXPORT KoSvgTextShape : public KoSvgTextChunkShape
{
......
......@@ -54,8 +54,8 @@ public:
/**
* @brief upload the svg representation of text into the shape
* @param svgText <text> part of SVG
* @param stylesText <defs> part of SVG (used only for gradients and patterns)
* @param svgText \<text\> part of SVG
* @param stylesText \<defs\> part of SVG (used only for gradients and patterns)
* @param boundsInPixels bounds of the entire image in pixel. Used for parsing percentage units.
* @param pixelsPerInch resolution of the image where we load the shape to
*
......@@ -66,7 +66,7 @@ public:
/**
* @brief convertToHtml convert the text in the text shape to html
* @param htmlText will be filled with correct html representing the text in the shape
* @return true om success
* @return @c true on success
*/
bool convertToHtml(QString *htmlText);
......@@ -75,7 +75,7 @@ public:
* @param htmlText the input html
* @param svgText the converted svg text element
* @param styles
* @return true if the conversion was successful
* @return @c true if the conversion was successful
*/
bool convertFromHtml(const QString &htmlText, QString *svgText, QString *styles);
......@@ -83,15 +83,15 @@ public:
* @brief convertDocumentToSvg
* @param doc the QTextDocument to convert.
* @param svgText the converted svg text element
* @return true if the conversion was successful
* @return @c true if the conversion was successful
*/
bool convertDocumentToSvg(const QTextDocument *doc, QString *svgText);
/**
* @brief convertSvgToDocument
* @param svgText the <text> element and it's children as a string.
* @param svgText the \<text\> element and it's children as a string.
* @param doc the QTextDocument that the conversion is written to.
* @return true if the conversion was successful
* @return @c true if the conversion was successful
*/
bool convertSvgToDocument(const QString &svgText, QTextDocument *doc);
......
......@@ -25,7 +25,7 @@
/**
* This is a base class for filters that implement a filter for
* \ref KoColorTransformation based filters.
* \ref KoColorTransformationFactory based filters.
*/
class KRITAIMAGE_EXPORT KisColorTransformationFilter : public KisFilter
{
......
......@@ -97,7 +97,7 @@ public:
virtual QRect neededRect(const QRect & rect, const KisFilterConfigurationSP config, int lod) const;
/**
* Similar to \ref neededRect: some filters will alter a lot of pixels that are
* Similar to @ref neededRect : some filters will alter a lot of pixels that are
* near to each other at the same time. So when you changed a single rectangle
* in a device, the actual rectangle that will feel the influence of this change
* might be bigger. Use this function to determine that rect.
......
......@@ -18,7 +18,7 @@
*/
/**
* @file
* @file kis_adjustment_layer.h
* This file is part of the Krita calligra application. It handles
* a contains a KisFilter OR a KisLayer, and this class is created
* to influence the rendering of layers below this one. Can also
......@@ -39,7 +39,9 @@
class KisFilterConfiguration;
/**
* @class KisAdjustmentLayer Contains a KisFilter and a KisSelection.
* @class KisAdjustmentLayer
* @brief Contains a KisFilter and a KisSelection.
*
* If the selection is present, it is a mask used by the adjustment layer
* to know where to apply the filter, thus the combination is used
* to influence the rendering of the layers under this layer
......
......@@ -19,7 +19,8 @@
*/
/**
* @file this file is part of the Krita application in calligra
* @file kis_annotation.h
* @brief This file is part of the Krita application in calligra
* @author Boudewijn Rempt
* @author comments by hscott
* @since 1.4 or 2005
......@@ -34,7 +35,8 @@
#include <QString>
/**
* @class KisAnnotation A data extension mechanism for Krita.
* @class KisAnnotation
* @brief A data extension mechanism for Krita.
*
* An annotation can be of something like a QByteArray or a QString or
* a more specific datatype that can be attached to an image (or maybe
......
......@@ -52,13 +52,13 @@ namespace tmp {
* and offset (\p dx) parameters.
*
* Notation:
* <pixel_name>_l -- leftmost border of the pixel
* <pixel_name>_c -- center of the pixel
* \<pixel_name\>_l -- leftmost border of the pixel
* \<pixel_name\>_c -- center of the pixel
*
*
* Example calculation of an offset (see calculateBlendSpan()):
* scale = 0.5;
* offset = <very small value>
* offset = \<very small value\>
*
* +------ dst_l
* |
......@@ -77,11 +77,11 @@ namespace tmp {
* |++--- offset (near zero, measured in dst coordinates)
* |
* +-- _l position of the pixel, which is considered
* cetral in the weights buffer
* central in the weights buffer
*
* Another example calculation of an offset (see calculateBlendSpan()):
* scale = 0.5;
* offset = <high value near 0.5>
* offset = \<high value near 0.5\>
*
* +------ dst_l
* |
......@@ -100,7 +100,7 @@ namespace tmp {
* +|-+--- offset (near 0.5, measured in dst coordinates)
* |
* +-- _l position of the pixel, which is considered
* cetral in the weights buffer
* central in the weights buffer
*/
class KisFilterWeightsApplicator
......
......@@ -59,7 +59,7 @@ public:
* setRect sets the rect of the fixed paint device to rect.
* This will _not_ create the associated data area.
*
* @rect the bounds in pixels. The x,y of the rect represent the origin
* @param rc the bounds in pixels. The x,y of the rect represent the origin
* of the fixed paint device.
*/
void setRect(const QRect& rc);
......
......@@ -729,9 +729,7 @@ Q_SIGNALS:
/**
* Emitted whenever an action has caused the image to be
* recomposited.
*
* @param rc The rect that has been recomposited.
* recomposited. Parameter is the rect that has been recomposited.
*/
void sigImageUpdated(const QRect &);
......
......@@ -52,9 +52,9 @@ protected:
KisMergeWalker(Flags flags) : m_flags(flags) {}
/**
* Begins visiting nodes starting with @startWith.
* Begins visiting nodes starting with @p startWith.
* First it climbs to the top of the graph, collecting
* changeRects (it calls @registerChangeRect for every node).
* changeRects (it calls @ref registerChangeRect for every node).
* Then it goes down to the bottom collecting needRects
* for every branch.
*/
......
......@@ -38,7 +38,7 @@ void KRITAIMAGE_EXPORT kis_debug_save_device_incremental(KisPaintDeviceSP device
* called. That is very convenient for debugging canvas updates:
* adding this macro will let you track the whole history of updates.
*
* The files are saved with pattern: <counter>_<suffix>.png
* The files are saved with pattern: \<counter\>_\<suffix\>.png
*/
#define KIS_DUMP_DEVICE_1(device, rc, suffix) \
do { \
......@@ -56,7 +56,7 @@ void KRITAIMAGE_EXPORT kis_debug_save_device_incremental(KisPaintDeviceSP device
* The \p prefix parameter makes it easy to sort out dumps from
* different functions.
*
* The files are saved with pattern: <prefix>_<counter>_<suffix>.png
* The files are saved with pattern: \<prefix\>_\<counter\>_\<suffix\>.png
*/
#define KIS_DUMP_DEVICE_2(device, rc, suffix, prefix) \
do { \
......
......@@ -278,10 +278,10 @@ public:
qint32 srcWidth, qint32 srcHeight);
/**
* Blast a region of srcWidth @param srcWidth and srcHeight @param srcHeight from @param srcDev onto the current
* paint device. @param srcX and @param srcY set the x and y positions of the
* origin top-left corner, @param dstX and @param dstY those of the destination.
* @param srcDev is a \ref KisFixedPaintDevice: this means that @param srcDev must have the same
* Blast a region of srcWidth @p srcWidth and srcHeight @p srcHeight from @p srcDev onto the current
* paint device. @p srcX and @p srcY set the x and y positions of the
* origin top-left corner, @p dstX and @p dstY those of the destination.
* @p srcDev is a @ref KisFixedPaintDevice : this means that @p srcDev must have the same
* colorspace as the destination device.
*
* @param dstX the destination x-coordinate
......@@ -317,20 +317,20 @@ public:
void bltFixed(const QPoint & pos, const KisFixedPaintDeviceSP srcDev, const QRect & srcRect);
/**
* Blasts a @param selection of srcWidth @param srcWidth and srcHeight @param srcHeight
* of @param srcDev on the current paint device. There is parameters to control
* the top-left corner of the area in each respective paint device (@param dstX,
* @param dstY, @param srcX, @param srcY).
* @param selection can be used as a mask to shape @param srcDev to something
* Blasts a @p selection of srcWidth @p srcWidth and srcHeight @p srcHeight
* of @p srcDev on the current paint device. There is parameters to control
* the top-left corner of the area in each respective paint device (@p dstX,
* @p dstY, @p srcX, @p srcY).
* @p selection can be used as a mask to shape @p srcDev to something
* interesting in the same step it is rendered to the current paint device.
* @param srcDev is a \ref KisFixedPaintDevice: this means that @param srcDev
* @p srcDev is a @ref KisFixedPaintDevice : this means that @p srcDev
* must have the same colorspace as the destination device.
* @param selection 's colorspace must be alpha8 (the colorspace for
* @p selection 's colorspace must be alpha8 (the colorspace for
* selections/transparency).
* The rectangle formed by the respective top-left coordinates of each device
* and @param srcWidth and @param srcHeight must not go beyond their limits, and
* and @p srcWidth and @p srcHeight must not go beyond their limits, and
* they must be different from zero.
* @param selection and KisPainter's selection (the user selection) are
* @p selection and KisPainter's selection (the user selection) are
* fused together through the composite operation COMPOSITE_MULT.
*
* @param dstX the destination x-coordinate
......
......@@ -31,7 +31,8 @@
class KisFilterConfiguration;
/**
* @class KisSelectionBasedLayer describes base behaviour for
* @class KisSelectionBasedLayer
* @brief Describes base behaviour for
* selection base classes like KisAdjustmentLayer and KisGeneratorLayer.
* These classes should have a persistent selection that controls
* the area where filter/generators are applied. The area outside
......
......@@ -103,8 +103,8 @@ public:
* TS - shear origin transpose
* S - shear itself (shearX * shearY)
* SC - scale
* R - rotation (@rotation parameter)
* T - transpose (@xtranslate, @ytranslate)
* R - rotation (@p rotation parameter)
* T - transpose (@p xtranslate, @p ytranslate)
*
* WARNING: due to some rounding problems in the worker
* the work it does does not correspond to the matrix exactly!
......
......@@ -39,7 +39,7 @@ namespace KisLazyFillTools
/**
* Uses Boykov-Kolmogorov Max-Flow/Min-Cut algorithm to split the
* device \src into two parts. The first part is defined by \p
* device \p src into two parts. The first part is defined by \p
* colorScribble and the second part --- by \p
* backgroundScribble. In the result of the split the area defined
* by \p colorScribble in \p resultDevice is filled with \p
......
......@@ -612,7 +612,7 @@ class bk_max_flow {
}
/**
* checks if vertex v has a connect to the sink-vertex (@var m_sink)
* checks if vertex v has a connect to the sink-vertex (@p m_sink)
* @param v the vertex which is checked
* @return true if a path to the sink was found, false if not
*/
......@@ -649,7 +649,7 @@ class bk_max_flow {
}
/**
* checks if vertex v has a connect to the source-vertex (@var m_source)
* checks if vertex v has a connect to the source-vertex (@p m_source)
* @param v the vertex which is checked
* @return true if a path to the source was found, false if not
*/
......
......@@ -83,9 +83,11 @@ public Q_SLOTS:
* @brief scalingMethod
* returns how the file referenced is scaled.
* @return one of the following:
* <ul>
* <li> None - The file is not scaled in any way.
* <li> ToImageSize - The file is scaled to the full image size;
* <li> ToImagePPI - The file is scaled by the PPI of the image. This keep the physical dimensions the same.
* </ul>
*/
QString scalingMethod() const;
......
......@@ -81,11 +81,14 @@ public Q_SLOTS:
/**
* @brief Apply the filter to the given node.
* @param node the node to apply the filter to
* @params x, y, w, h: describe the rectangle the filter should be apply.
* @param x
* @param y
* @param w
* @param h describe the rectangle the filter should be apply.
* This is always in image pixel coordinates and not relative to the x, y
* of the node.
* @return true if the filter was applied successfully, or
* false if the filter could not be applied because the node is locked or
* @return @c true if the filter was applied successfully, or
* @c false if the filter could not be applied because the node is locked or
* does not have an editable paint device.
*/
bool apply(Node *node, int x, int y, int w, int h);
......@@ -94,7 +97,10 @@ public Q_SLOTS:
* @brief startFilter starts the given filter on the given node.
*
* @param node the node to apply the filter to
* @params x, y, w, h: describe the rectangle the filter should be apply.
* @param x
* @param y
* @param w
* @param h describe the rectangle the filter should be apply.
* This is always in image pixel coordinates and not relative to the x, y
* of the node.
*/
......
......@@ -55,7 +55,7 @@ public:
public Q_SLOTS:
/**
* set the property identified by @key to @value
* set the property identified by @p key to @p value
*
* If you want create a property that represents a color, you can use a QColor
* or hex string, as defined in http://doc.qt.io/qt-5/qcolor.html#setNamedColor.
......
......@@ -34,6 +34,7 @@
class KisSwatch;
/**
* @class PaletteView
* @brief The PaletteView class is a wrapper around a MVC method for handling
* palettes. This class shows a nice widget that can drag and drop, edit colors in a colorset
* and will handle adding and removing entries if you'd like it to.
......
......@@ -203,12 +203,12 @@ public:
* Serialize this color following Create's swatch color specification available
* at http://create.freedesktop.org/wiki/index.php/Swatches_-_colour_file_format
*
* This function doesn't create the <color /> element but rather the <CMYK />,
* <sRGB />, <RGB /> ... elements. It is assumed that colorElt is the <color />
* This function doesn't create the \<color /\> element but rather the \<CMYK /\>,
* \<sRGB /\>, \<RGB /\> ... elements. It is assumed that colorElt is the \<color /\>
* element.
*
* @param colorElt root element for the serialization, it is assumed that this
* element is <color />
* element is \<color /\>
* @param doc is the document containing colorElt
*/
void toXML(QDomDocument& doc, QDomElement& colorElt) const;
......@@ -217,7 +217,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 elt the element to unserialize (<CMYK />, <sRGB />, <RGB />)
* @param elt the element to unserialize (\<CMYK /\>, \<sRGB /\>, \<RGB /\>)
* @param bitDepthId the bit depth is unspecified by the spec, this allow to select
* a preferred bit depth for creating the KoColor object (if that
* bit depth isn't available, this function will randomly select
......@@ -231,7 +231,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 elt the element to unserialize (<CMYK />, <sRGB />, <RGB />)
* @param elt the element to unserialize (\<CMYK /\>, \<sRGB /\>, \<RGB /\>)
* @param bitDepthId the bit depth is unspecified by the spec, this allow to select
* a preferred bit depth for creating the KoColor object (if that
* bit depth isn't available, this function will randomly select
......
......@@ -552,13 +552,13 @@ public:
* Serialize this color following Create's swatch color specification available
* at http://create.freedesktop.org/wiki/index.php/Swatches_-_colour_file_format
*
* This function doesn't create the <color /> element but rather the <CMYK />,
* <sRGB />, <RGB /> ... elements. It is assumed that colorElt is the <color />
* This function doesn't create the \<color /\> element but rather the \<CMYK /\>,
* \<sRGB /\>, \<RGB /\> ... elements. It is assumed that colorElt is the \<color /\>
* element.
*
* @param pixel buffer to serialized
* @param colorElt root element for the serialization, it is assumed that this
* element is <color />
* element is \<color /\>
* @param doc is the document containing colorElt
*/
virtual void colorToXML(const quint8* pixel, QDomDocument& doc, QDomElement& colorElt) const = 0;
......@@ -568,7 +568,7 @@ public:
* at http://create.freedesktop.org/wiki/index.php/Swatches_-_colour_file_format
*
* @param pixel buffer where the color will be unserialized
* @param elt the element to unserialize (<CMYK />, <sRGB />, <RGB />)
* @param elt the element to unserialize (\<CMYK /\>, \<sRGB /\>, \<RGB /\>)
* @return the unserialize color, or an empty color object if the function failed
* to unserialize the color
*/
......
......@@ -29,6 +29,7 @@
#include <KoGenericRegistry.h>
#include <KoColorSpace.h>
#include <KoColorSpaceFactory.h>
#include <KoConfig.h>
class KoColorProfile;
class KoColorConversionSystem;
......@@ -239,7 +240,6 @@ public:
*/
const KoColorSpace *alpha8();
const KoColorSpace *alpha16();
#include <KoConfig.h>
#ifdef HAVE_OPENEXR
const KoColorSpace *alpha16f();
#endif
......
......@@ -38,39 +38,39 @@ public:
~KoConvolutionOpImpl() override { }
/**
* Calculates a weighted average of the pixels, mentioned in @colors
* using weight values from @kernelValues
* Calculates a weighted average of the pixels, mentioned in @p colors
* using weight values from @p kernelValues
*
* Note:
* It behaves in a quite unclear way, when at least one pixel is
* fully transparent. There are three cases:
* Case A) None of the pixels is fully transparent.
* * Every color channel AND alpha channel of @dst stores a sum
* of the corresponding channels from @colors, divided by @factor
* and incremented by @offset
* Case B) At least one pixel of @colors is transparent and @factor
* * Every color channel AND alpha channel of @p dst stores a sum
* of the corresponding channels from @p colors, divided by @p factor
* and incremented by @p offset
* Case B) At least one pixel of @p colors is transparent and @p factor
* stores a weight of the kernel (sum of it's items).
* * Every color channel of @dst stores a sum of the corresponding
* * Every color channel of @p dst stores a sum of the corresponding
* channels from non-transparent pixels, divided by a weight
* of non-transparent pixels and incremented by @offset.
* * Alpha channel of @dst stores a sum of the corresponding
* of non-transparent pixels and incremented by @p offset.
* * Alpha channel of @p dst stores a sum of the corresponding
* channels from non-transparent pixels, divided by a weight
* of all the pixels (equals to @factor) and incremented
* by @offset.
* Case C) At least one pixel of @colors is transparent and @factor
* of all the pixels (equals to @p factor) and incremented
* by @p offset.
* Case C) At least one pixel of @p colors is transparent and @p factor
* is set to an arbitrary value.
* * Every color channel of @dst stores a sum of the corresponding
* * Every color channel of @p dst stores a sum of the corresponding
* channels from non-transparent pixels, divided by a "scaled
* down factor" and incremented by @offset. "Scaled
* down factor" and incremented by @p offset. "Scaled
* down factor" is calculated in the following way:
*
* [weight of non-transparent pixels]
* scaledDownFactor = @factor * ----------------------------------
* scaledDownFactor = @p factor * ----------------------------------
* [weight of all the pixels]
*
* * Alpha channel of @dst stores a sum of the corresponding
* * Alpha channel of @p dst stores a sum of the corresponding
* channels from non-transparent pixels, divided by unscaled
* @factor and incremented by @offset.
* @p factor and incremented by @p offset.
*/
void convolveColors(const quint8* const* colors, const qreal* kernelValues, quint8 *dst, qreal factor, qreal offset, qint32 nPixels, const QBitArray & channelFlags) const override {
......
......@@ -161,17 +161,19 @@ KRITASTORE_EXPORT bool setDocument(KoXmlDocument& doc, QIODevice* device,
/**
* \def forEachElement( elem, parent )
* \brief Loop through all child elements of \parent.
* \brief Loop through all child elements of \p parent.
* This convenience macro is used to implement the forEachElement loop.
* The \elem parameter is a name of a QDomElement variable and the \parent
* The \p elem parameter is a name of a QDomElement variable and the \p parent
* is the name of the parent element. For example:
*
* \code
* QDomElement e;
* forEachElement( e, parent )
* {
* qDebug() << e.localName() << " element found.";
* ...
* }
* \endcode
*/
#define forEachElement( elem, parent ) \
for ( KoXmlNode _node = parent.firstChild(); !_node.isNull(); _node = _node.nextSibling() ) \
......
......@@ -39,11 +39,11 @@
* this class is however not reentrant
*
* Needs to be used like this, otherwise will crash:
* <sl>
* <ul>
* <li>add content with newItem()</li>
* <li>finish adding content with squeeze()</li>
* <li>just read content with operator[]</li>
* </sl>
* </ul>
*
* @param uncompressedItemCount when number of buffered items reach this,
* compression will start small value will give better memory usage at the
......
......@@ -43,7 +43,7 @@ public:
/**
* Constructor
* @param parent the parent widget.
* @param mimeType the template-type (group) that should be selected on creation.
* @param mimeFilter 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());
......
......@@ -42,7 +42,7 @@ class KRITAUI_EXPORT KisResourceBundle : public KoResource
public:
/**
* @brief ResourceBundle : Ctor *
* @param bundlePath the path of the bundle
* @param fileName the path of the bundle
*/
KisResourceBundle(QString const& fileName);
......
......@@ -67,9 +67,9 @@ public:
QRect patchRect();
/**
* Draws an m_interestRect of the patch onto @gc
* By the way it fits this rect into @dstRect
* @renderHints are directly transmitted to QPainter
* Draws an m_interestRect of the patch onto @p gc
* By the way it fits this rect into @p dstRect
* @p renderHints are directly transmitted to QPainter
*/
void drawMe(QPainter &gc,
const QRectF &dstRect,
......
......@@ -57,7 +57,7 @@
#define isOdd(x) ((x) & 0x01)
/**
* Aligns @value to the lowest integer not smaller than @value and
* Aligns @p value to the lowest integer not smaller than @p value and
* that is a divident of alignment
*/
inline void alignByPow2Hi(qint32 &value, qint32 alignment)
......@@ -68,7 +68,7 @@ inline void alignByPow2Hi(qint32 &value, qint32 alignment)
}
/**
* Aligns @value to the lowest integer not smaller than @value and
* Aligns @p value to the lowest integer not smaller than @p value and
* that is, increased by one, a divident of alignment
*/
inline void alignByPow2ButOneHi(qint32 &value, qint32 alignment)
......@@ -78,8 +78,8 @@ inline void alignByPow2ButOneHi(qint32 &value, qint32 alignment)
}
/**
* Aligns @value to the highest integer not exceeding @value and
* that is a divident of @alignment
* Aligns @p value to the highest integer not exceeding @p value and
* that is a divident of @p alignment
*/
inline void alignByPow2Lo(qint32 &value, qint32 alignment)
{
......
......@@ -86,12 +86,12 @@ public:
/**
* Draws a piece of original image onto @p gc 's canvas
* @param info.imageRect - area in KisImage pixels where to read from
* @param info.viewportRect - area in canvas pixels where to write to
* @p info.imageRect - area in KisImage pixels where to read from
* @p info.viewportRect - area in canvas pixels where to write to
* If info.imageRect and info.viewportRect don't agree, the image
* will be scaled
* @param info.borderWidth has the same meaning as in getNearestPatch
* @param info.renderHints - hints, transmitted to QPainter during darwing
* @p info.borderWidth has the same meaning as in getNearestPatch
* @p info.renderHints - hints, transmitted to QPainter during darwing
*/
virtual void drawFromOriginalImage(QPainter& gc,
KisPPUpdateInfoSP info) = 0;
......
......@@ -105,13 +105,13 @@ public:
QRect dirtyImageRectVar;
/**
* Rect of KisImage corresponding to @viewportRect.
* Rect of KisImage corresponding to @ref viewportRect .
* It is cropped and aligned corresponding to the canvas.
*/
QRect imageRect;
/**
* Rect of canvas widget corresponding to @imageRect
* Rect of canvas widget corresponding to @ref imageRect
*/
QRectF viewportRect;
......
......@@ -44,9 +44,9 @@ public:
* @param node the name of the adjustment node
* @param nfi filter interface
* @param paintDevice the paint device that is used as source for the preview
* @param layerName the name of the layer
* @param caption the caption for the dialog -- create or properties
* @param parent the widget parent of this dialog
* @param name the QObject name, if any
*/
KisDlgAdjustmentLayer(KisNodeSP node,
KisNodeFilterInterface* nfi,
......
......@@ -403,7 +403,7 @@ inline QPointF QWindowsTabletDeviceData::scaleCoordinates(int coordX, int coordY
/*!
\class QWindowsWinTab32DLL QWindowsTabletSupport
\class QWindowsWinTab32DLL
\brief Functions from wintabl32.dll shipped with WACOM tablets used by QWindowsTabletSupport.
\internal
......
......@@ -26,7 +26,7 @@
#include <QStyledItemDelegate>
/**
* This delegate draw categories using information from a \ref KCategorizedSortFilterProxyModel .
* This delegate draw categories using information from a QSortFilterProxyModel.
*/
class KRITAUI_EXPORT KisCategorizedItemDelegate: public QStyledItemDelegate
{
......
......@@ -24,7 +24,8 @@
#include <functional>
/**
* \class KisDeferredSignal is used for calling a specified callback
* \class KisDeferredSignal
* \brief This class is used for calling a specified callback
* function (which is a std::function) after a specified time
* delay. The callback is called from the QTimer event, so the
* usage of the class does not block the Qt's event loop.
......
......@@ -104,12 +104,14 @@ public:
/**
* Save a layer to a PNG
* @param filename the name of the destination file
* @param imageRect the image rectangle to save
* @param xRes resolution along x axis
* @param yRes resolution along y axis
* @param device the paint device to save
* @param annotationsStart an iterator on the first annotation
* @param annotationsEnd an iterator on the last annotation
* @param compression a number between 0 and 9 to specify the compression rate (9 is most compressed)