diff --git a/ViewSolutions/src/colorpicker.h b/ViewSolutions/src/colorpicker.h index c91b2f9..b66b17f 100644 --- a/ViewSolutions/src/colorpicker.h +++ b/ViewSolutions/src/colorpicker.h @@ -7,7 +7,7 @@ namespace ViewSolutions { /** - * @brief The ColorPicker class - this class provide methods of get generals colors from images. + * @brief The ColorPicker class - This class provide methods of get generals colors from images. */ class LOGINVIEW_EXPORT ColorPicker { @@ -15,26 +15,26 @@ public: explicit ColorPicker(); /** - * @brief pick - get color from point - * @arg x - * @arg y - * @arg img - source image - * @return color of point. + * @brief pick Get color from point. + * @arg x This is x coordinate. + * @arg y This is y coordinate. + * @arg img Source image. + * @return Color of point. */ QColor pick(int x, int y, const QImage &img) const; /** - * @brief pick - color from all image. This method get pixels from grid of image - * @param img - source image - * @param density - counnt of checked pixels on one plane and planes count. @default 5 - * @return General color of image + * @brief pick Color from all image. This method get pixels from grid of image. + * @param img Source image. + * @param density Count of checked pixels on one plane and planes count, default 5. + * @return General color of image. */ QColor pick(const QImage &img, int density = 5) const; /** - * @brief pick - this is override function for qml - * @param img - path to image - * @return General color of image + * @brief pick This is override function for qml. + * @param img Path to image. + * @return General color of image. */ QColor pick(const QString &img) const; diff --git a/ViewSolutions/src/qmlcolorpicker.h b/ViewSolutions/src/qmlcolorpicker.h index 4ca0c9a..812c8bf 100644 --- a/ViewSolutions/src/qmlcolorpicker.h +++ b/ViewSolutions/src/qmlcolorpicker.h @@ -8,7 +8,7 @@ class QQmlApplicationEngine; namespace ViewSolutions { /** - * @brief The QMLColorPicker class - qml wraper for ColorPicker clas + * @brief The QMLColorPicker class - Qml wrapper for ColorPicker class. */ class LOGINVIEW_EXPORT QMLColorPicker : public QObject, private ColorPicker { @@ -17,14 +17,14 @@ public: explicit QMLColorPicker(QObject *parent = nullptr); /** * @brief instance This method return instance object of the QMLColorPicker setvice. - * @return static instance of this ColorPicker + * @return Static instance of this ColorPicker. */ static QMLColorPicker* instance(); /** - * @brief pick This is override function for qml - * @param img This is path to image - * @return General color of image + * @brief pick This is override function for qml. + * @param img This is path to image. + * @return General color of image. */ Q_INVOKABLE QColor pick(const QString &img) const;