Merge pull request #26373 from Kumataro:fix26372

doc: fix doxygen errors at Algorithm and QRCodeEncoder #26373

Close https://github.com/opencv/opencv/issues/26372

### Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

- [x] I agree to contribute to the project under Apache 2 License.
- [x] To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV
- [x] The PR is proposed to the proper branch
- [x] There is a reference to the original bug report and related work
- [ ] There is accuracy test, performance test and test data in opencv_extra repository, if applicable
      Patch to opencv_extra has the same branch name.
- [ ] The feature is well documented and sample code can be built with the project CMake
This commit is contained in:
Kumataro 2024-10-28 15:20:04 +09:00 committed by GitHub
parent 8a5ec4bf7b
commit 3b01a4d4e9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 3 deletions

View File

@ -3114,6 +3114,10 @@ class CV_EXPORTS Algorithm;
template<typename _Tp, typename _EnumTp = void> struct ParamType {}; template<typename _Tp, typename _EnumTp = void> struct ParamType {};
/** @example samples/cpp/snippets/detect_blob.cpp
An example using the BLOB to detect and filter region.
*/
/** @brief This is a base class for all more or less complex algorithms in OpenCV /** @brief This is a base class for all more or less complex algorithms in OpenCV
especially for classes of algorithms, for which there can be multiple implementations. The examples especially for classes of algorithms, for which there can be multiple implementations. The examples
@ -3125,9 +3129,6 @@ etc.).
Here is example of SimpleBlobDetector use in your application via Algorithm interface: Here is example of SimpleBlobDetector use in your application via Algorithm interface:
@snippet snippets/core_various.cpp Algorithm @snippet snippets/core_various.cpp Algorithm
@example samples/cpp/snippets/detect_blob.cpp
An example using the BLOB to detect and filter region.
*/ */
class CV_EXPORTS_W Algorithm class CV_EXPORTS_W Algorithm
{ {

View File

@ -87,6 +87,7 @@ namespace cv
//! @addtogroup objdetect_qrcode //! @addtogroup objdetect_qrcode
//! @{ //! @{
/** @brief QR code encoder. */
class CV_EXPORTS_W QRCodeEncoder { class CV_EXPORTS_W QRCodeEncoder {
protected: protected:
QRCodeEncoder(); // use ::create() QRCodeEncoder(); // use ::create()
@ -151,6 +152,8 @@ public:
CV_WRAP virtual void encodeStructuredAppend(const String& encoded_info, OutputArrayOfArrays qrcodes) = 0; CV_WRAP virtual void encodeStructuredAppend(const String& encoded_info, OutputArrayOfArrays qrcodes) = 0;
}; };
/** @brief QR code detector. */
class CV_EXPORTS_W_SIMPLE QRCodeDetector : public GraphicalCodeDetector class CV_EXPORTS_W_SIMPLE QRCodeDetector : public GraphicalCodeDetector
{ {
public: public:
@ -192,6 +195,7 @@ public:
OutputArray straight_qrcode = noArray()); OutputArray straight_qrcode = noArray());
}; };
/** @brief QR code detector based on Aruco markers detection code. */
class CV_EXPORTS_W_SIMPLE QRCodeDetectorAruco : public GraphicalCodeDetector { class CV_EXPORTS_W_SIMPLE QRCodeDetectorAruco : public GraphicalCodeDetector {
public: public:
CV_WRAP QRCodeDetectorAruco(); CV_WRAP QRCodeDetectorAruco();