From cc7f17f011083060979b980360e2744607b5972e Mon Sep 17 00:00:00 2001 From: Suleyman TURKMEN Date: Wed, 28 Oct 2020 04:51:12 +0300 Subject: [PATCH] update documentation --- modules/core/include/opencv2/core.hpp | 9 ++++++++ modules/highgui/include/opencv2/highgui.hpp | 29 +++++++++++++++++-------- modules/imgcodecs/include/opencv2/imgcodecs.hpp | 6 +++++ 3 files changed, 35 insertions(+), 9 deletions(-) diff --git a/modules/core/include/opencv2/core.hpp b/modules/core/include/opencv2/core.hpp index 6eb519e..fc2432d 100644 --- a/modules/core/include/opencv2/core.hpp +++ b/modules/core/include/opencv2/core.hpp @@ -202,6 +202,9 @@ enum CovarFlags { COVAR_COLS = 16 }; +//! @addtogroup core_cluster +//! @{ + //! k-Means flags enum KmeansFlags { /** Select random initial centers in each attempt.*/ @@ -215,6 +218,8 @@ enum KmeansFlags { KMEANS_USE_INITIAL_LABELS = 1 }; +//! @} core_cluster + //! type of line enum LineTypes { FILLED = -1, @@ -236,12 +241,16 @@ enum HersheyFonts { FONT_ITALIC = 16 //!< flag for italic font }; +//! @addtogroup core_array +//! @{ + enum ReduceTypes { REDUCE_SUM = 0, //!< the output is the sum of all rows/columns of the matrix. REDUCE_AVG = 1, //!< the output is the mean vector of all rows/columns of the matrix. REDUCE_MAX = 2, //!< the output is the maximum (column/row-wise) of all rows/columns of the matrix. REDUCE_MIN = 3 //!< the output is the minimum (column/row-wise) of all rows/columns of the matrix. }; +//! @} core_array /** @brief Swaps two matrices */ diff --git a/modules/highgui/include/opencv2/highgui.hpp b/modules/highgui/include/opencv2/highgui.hpp index 628b7fa..6a8c598 100644 --- a/modules/highgui/include/opencv2/highgui.hpp +++ b/modules/highgui/include/opencv2/highgui.hpp @@ -66,6 +66,7 @@ It provides easy interface to: - Add trackbars to the windows, handle simple mouse events as well as keyboard commands. @{ + @defgroup highgui_window_flags Flags related creating and manipulating HighGUI windows and mouse events @defgroup highgui_opengl OpenGL support @defgroup highgui_qt Qt New Functions @@ -93,7 +94,7 @@ It provides easy interface to: namedWindow("main1",WINDOW_NORMAL); - namedWindow("main2",WINDOW_AUTOSIZE | CV_GUI_NORMAL); + namedWindow("main2",WINDOW_AUTOSIZE | WINDOW_GUI_NORMAL); createTrackbar( "track1", "main1", &value, 255, NULL); String nameb1 = "button1"; @@ -178,6 +179,9 @@ namespace cv //! @addtogroup highgui //! @{ +//! @addtogroup highgui_window_flags +//! @{ + //! Flags for cv::namedWindow enum WindowFlags { WINDOW_NORMAL = 0x00000000, //!< the user can resize the window (no constraint) / also use to switch a fullscreen window to a normal size. @@ -227,6 +231,11 @@ enum MouseEventFlags { EVENT_FLAG_ALTKEY = 32 //!< indicates that ALT Key is pressed. }; +//! @} highgui_window_flags + +//! @addtogroup highgui_qt +//! @{ + //! Qt font weight enum QtFontWeights { QT_FONT_LIGHT = 25, //!< Weight of 25 @@ -251,6 +260,8 @@ enum QtButtonTypes { QT_NEW_BUTTONBAR = 1024 //!< Button should create a new buttonbar }; +//! @} highgui_qt + /** @brief Callback function for mouse events. see cv::setMouseCallback @param event one of the cv::MouseEventTypes constants. @param x The x-coordinate of the mouse event. @@ -389,7 +400,7 @@ videos, it will display the video frame-by-frame) */ CV_EXPORTS_W void imshow(const String& winname, InputArray mat); -/** @brief Resizes window to the specified size +/** @brief Resizes the window to the specified size @note @@ -408,7 +419,7 @@ CV_EXPORTS_W void resizeWindow(const String& winname, int width, int height); */ CV_EXPORTS_W void resizeWindow(const String& winname, const cv::Size& size); -/** @brief Moves window to the specified position +/** @brief Moves the window to the specified position @param winname Name of the window. @param x The new x-coordinate of the window. @@ -476,8 +487,6 @@ For cv::EVENT_MOUSEWHEEL positive and negative values mean forward and backward respectively. For cv::EVENT_MOUSEHWHEEL, where available, positive and negative values mean right and left scrolling, respectively. -With the C API, the macro CV_GET_WHEEL_DELTA(flags) can be used alternatively. - @note Mouse-wheel events are currently supported only on Windows. @@ -486,8 +495,9 @@ Mouse-wheel events are currently supported only on Windows. */ CV_EXPORTS int getMouseWheelDelta(int flags); -/** @brief Selects ROI on the given image. -Function creates a window and allows user to select a ROI using mouse. +/** @brief Allows users to select a ROI on the given image. + +The function creates a window and allows users to select a ROI using the mouse. Controls: use `space` or `enter` to finish selection, use key `c` to cancel selection (function will return the zero cv::Rect). @param windowName name of the window where selection process will be shown. @@ -506,8 +516,9 @@ CV_EXPORTS_W Rect selectROI(const String& windowName, InputArray img, bool showC */ CV_EXPORTS_W Rect selectROI(InputArray img, bool showCrosshair = true, bool fromCenter = false); -/** @brief Selects ROIs on the given image. -Function creates a window and allows user to select a ROIs using mouse. +/** @brief Allows users to select multiple ROIs on the given image. + +The function creates a window and allows users to select multiple ROIs using the mouse. Controls: use `space` or `enter` to finish current selection and start a new one, use `esc` to terminate multiple ROI selection process. diff --git a/modules/imgcodecs/include/opencv2/imgcodecs.hpp b/modules/imgcodecs/include/opencv2/imgcodecs.hpp index e2636e1..7f6b24f 100644 --- a/modules/imgcodecs/include/opencv2/imgcodecs.hpp +++ b/modules/imgcodecs/include/opencv2/imgcodecs.hpp @@ -49,6 +49,7 @@ @defgroup imgcodecs Image file reading and writing @{ @defgroup imgcodecs_c C API + @defgroup imgcodecs_flags Flags used for image file reading and writing @defgroup imgcodecs_ios iOS glue @} */ @@ -60,6 +61,9 @@ namespace cv //! @addtogroup imgcodecs //! @{ +//! @addtogroup imgcodecs_flags +//! @{ + //! Imread flags enum ImreadModes { IMREAD_UNCHANGED = -1, //!< If set, return the loaded image as is (with alpha channel, otherwise it gets cropped). Ignore EXIF orientation. @@ -130,6 +134,8 @@ enum ImwritePAMFlags { IMWRITE_PAM_FORMAT_RGB_ALPHA = 5, }; +//! @} imgcodecs_flags + /** @brief Loads an image from a file. @anchor imread -- 2.7.4