From bef177c7186377c73ab81a3a388350ffdb08f99f Mon Sep 17 00:00:00 2001 From: Maksim Shabunin Date: Tue, 17 Jan 2017 16:33:46 +0300 Subject: [PATCH] Minor documentation fixes: - dpm, freetype: fixed documentation blocks - datasets: removed tinyXml from public interface and documentation --- modules/datasets/src/or_pascal.cpp | 2 +- modules/datasets/src/tinyxml2/tinyxml2.cpp | 19 +++++++++---------- .../datasets => src}/tinyxml2/tinyxml2.h | 0 modules/datasets/src/tr_svt.cpp | 2 +- modules/dpm/include/opencv2/dpm.hpp | 5 +++++ modules/freetype/include/opencv2/freetype.hpp | 2 +- 6 files changed, 17 insertions(+), 13 deletions(-) rename modules/datasets/{include/opencv2/datasets => src}/tinyxml2/tinyxml2.h (100%) diff --git a/modules/datasets/src/or_pascal.cpp b/modules/datasets/src/or_pascal.cpp index 9afdf1d7e..a20fa44bd 100644 --- a/modules/datasets/src/or_pascal.cpp +++ b/modules/datasets/src/or_pascal.cpp @@ -41,7 +41,7 @@ #include "opencv2/datasets/or_pascal.hpp" #include "opencv2/datasets/util.hpp" -#include +#include "tinyxml2/tinyxml2.h" #include namespace cv diff --git a/modules/datasets/src/tinyxml2/tinyxml2.cpp b/modules/datasets/src/tinyxml2/tinyxml2.cpp index 815196995..47a1a0aac 100755 --- a/modules/datasets/src/tinyxml2/tinyxml2.cpp +++ b/modules/datasets/src/tinyxml2/tinyxml2.cpp @@ -21,7 +21,7 @@ must not be misrepresented as being the original software. distribution. */ -#include "opencv2/datasets/tinyxml2/tinyxml2.h" +#include "tinyxml2/tinyxml2.h" #include // yes, this one new style header, is in the Android SDK. # ifdef ANDROID_NDK @@ -593,7 +593,7 @@ XMLNode::~XMLNode() } } -const char* XMLNode::Value() const +const char* XMLNode::Value() const { return _value.GetStr(); } @@ -1063,12 +1063,12 @@ bool XMLUnknown::Accept( XMLVisitor* visitor ) const // --------- XMLAttribute ---------- // -const char* XMLAttribute::Name() const +const char* XMLAttribute::Name() const { return _name.GetStr(); } -const char* XMLAttribute::Value() const +const char* XMLAttribute::Value() const { return _value.GetStr(); } @@ -1271,7 +1271,7 @@ void XMLElement::SetText( const char* inText ) } -void XMLElement::SetText( int v ) +void XMLElement::SetText( int v ) { char buf[BUF_SIZE]; XMLUtil::ToStr( v, buf, BUF_SIZE ); @@ -1279,7 +1279,7 @@ void XMLElement::SetText( int v ) } -void XMLElement::SetText( unsigned v ) +void XMLElement::SetText( unsigned v ) { char buf[BUF_SIZE]; XMLUtil::ToStr( v, buf, BUF_SIZE ); @@ -1287,7 +1287,7 @@ void XMLElement::SetText( unsigned v ) } -void XMLElement::SetText( bool v ) +void XMLElement::SetText( bool v ) { char buf[BUF_SIZE]; XMLUtil::ToStr( v, buf, BUF_SIZE ); @@ -1295,7 +1295,7 @@ void XMLElement::SetText( bool v ) } -void XMLElement::SetText( float v ) +void XMLElement::SetText( float v ) { char buf[BUF_SIZE]; XMLUtil::ToStr( v, buf, BUF_SIZE ); @@ -1303,7 +1303,7 @@ void XMLElement::SetText( float v ) } -void XMLElement::SetText( double v ) +void XMLElement::SetText( double v ) { char buf[BUF_SIZE]; XMLUtil::ToStr( v, buf, BUF_SIZE ); @@ -2201,4 +2201,3 @@ bool XMLPrinter::Visit( const XMLUnknown& unknown ) } } // namespace tinyxml2 - diff --git a/modules/datasets/include/opencv2/datasets/tinyxml2/tinyxml2.h b/modules/datasets/src/tinyxml2/tinyxml2.h similarity index 100% rename from modules/datasets/include/opencv2/datasets/tinyxml2/tinyxml2.h rename to modules/datasets/src/tinyxml2/tinyxml2.h diff --git a/modules/datasets/src/tr_svt.cpp b/modules/datasets/src/tr_svt.cpp index af853d479..6d7d5a85a 100644 --- a/modules/datasets/src/tr_svt.cpp +++ b/modules/datasets/src/tr_svt.cpp @@ -42,7 +42,7 @@ #include "opencv2/datasets/tr_svt.hpp" #include "opencv2/datasets/util.hpp" -#include +#include "tinyxml2/tinyxml2.h" namespace cv { diff --git a/modules/dpm/include/opencv2/dpm.hpp b/modules/dpm/include/opencv2/dpm.hpp index 387a31123..ab604abf3 100644 --- a/modules/dpm/include/opencv2/dpm.hpp +++ b/modules/dpm/include/opencv2/dpm.hpp @@ -96,6 +96,9 @@ namespace cv namespace dpm { +//! @addtogroup dpm +//! @{ + /** @brief This is a C++ abstract class, it provides external user API to work with DPM. */ class CV_EXPORTS_W DPMDetector @@ -142,6 +145,8 @@ public: virtual ~DPMDetector(){} }; +//! @} + } // namespace dpm } // namespace cv diff --git a/modules/freetype/include/opencv2/freetype.hpp b/modules/freetype/include/opencv2/freetype.hpp index 40cdda6b1..6e41ec7ff 100644 --- a/modules/freetype/include/opencv2/freetype.hpp +++ b/modules/freetype/include/opencv2/freetype.hpp @@ -183,7 +183,7 @@ The function createFreeType2 create instance to draw UTF-8 strings. */ CV_EXPORTS_W Ptr createFreeType2(); -//! @] +//! @} } } // namespace freetype #endif