Update documentation

modules/core/doc/basic_structures.rst

@@ -2484,13 +2484,13 @@ Algorithm::set
 --------------
 Sets the algorithm parameter
 
-.. ocv:function:: void Algorithm::set(const string& name, int value)
-.. ocv:function:: void Algorithm::set(const string& name, double value)
-.. ocv:function:: void Algorithm::set(const string& name, bool value)
-.. ocv:function:: void Algorithm::set(const string& name, const string& value)
-.. ocv:function:: void Algorithm::set(const string& name, const Mat& value)
-.. ocv:function:: void Algorithm::set(const string& name, const vector<Mat>& value)
-.. ocv:function:: void Algorithm::set(const string& name, const Ptr<Algorithm>& value)
+.. ocv:function:: void Algorithm::set(const String& name, int value)
+.. ocv:function:: void Algorithm::set(const String& name, double value)
+.. ocv:function:: void Algorithm::set(const String& name, bool value)
+.. ocv:function:: void Algorithm::set(const String& name, const String& value)
+.. ocv:function:: void Algorithm::set(const String& name, const Mat& value)
+.. ocv:function:: void Algorithm::set(const String& name, const vector<Mat>& value)
+.. ocv:function:: void Algorithm::set(const String& name, const Ptr<Algorithm>& value)
 
     :param name: The parameter name.
     :param value: The parameter value.
@@ -2546,7 +2546,7 @@ Algorithm::create
 -----------------
 Creates algorithm instance by name
 
-.. ocv:function:: template<typename _Tp> Ptr<_Tp> Algorithm::create(const string& name)
+.. ocv:function:: template<typename _Tp> Ptr<_Tp> Algorithm::create(const String& name)
 
     :param name: The algorithm name, one of the names returned by ``Algorithm::getList()``.
 

modules/core/doc/command_line_parser.rst

@@ -10,7 +10,7 @@ CommandLineParser
 The CommandLineParser class is designed for command line arguments parsing
 
 
-    .. ocv:function:: CommandLineParser::CommandLineParser( int argc, const char* const argv[], const string& keys )
+    .. ocv:function:: CommandLineParser::CommandLineParser( int argc, const char* const argv[], const String& keys )
 
         :param argc:
         :param argv:
@@ -33,7 +33,7 @@ The CommandLineParser class is designed for command line arguments parsing
     .. ocv:function:: bool CommandLineParser::check()
 
 
-    .. ocv:function:: void CommandLineParser::about( const string& message )
+    .. ocv:function:: void CommandLineParser::about( const String& message )
 
         :param message:
 

modules/core/doc/drawing_functions.rst

@@ -225,7 +225,7 @@ getTextSize
 ---------------
 Calculates the width and height of a text string.
 
-.. ocv:function:: Size getTextSize(const string& text, int fontFace, double fontScale, int thickness, int* baseLine)
+.. ocv:function:: Size getTextSize(const String& text, int fontFace, double fontScale, int thickness, int* baseLine)
 
 .. ocv:pyfunction:: cv2.getTextSize(text, fontFace, fontScale, thickness) -> retval, baseLine
 
@@ -246,7 +246,7 @@ Calculates the width and height of a text string.
 The function ``getTextSize`` calculates and returns the size of a box that contains the specified text.
 That is, the following code renders some text, the tight box surrounding it, and the baseline: ::
 
-    string text = "Funny text inside the box";
+    String text = "Funny text inside the box";
     int fontFace = FONT_HERSHEY_SCRIPT_SIMPLEX;
     double fontScale = 2;
     int thickness = 3;
@@ -570,7 +570,7 @@ putText
 -----------
 Draws a text string.
 
-.. ocv:function:: void putText( Mat& img, const string& text, Point org,              int fontFace, double fontScale, Scalar color,              int thickness=1, int lineType=8,              bool bottomLeftOrigin=false )
+.. ocv:function:: void putText( Mat& img, const String& text, Point org, int fontFace, double fontScale, Scalar color, int thickness=1, int lineType=8, bool bottomLeftOrigin=false )
 
 .. ocv:pyfunction:: cv2.putText(img, text, org, fontFace, fontScale, color[, thickness[, lineType[, bottomLeftOrigin]]]) -> None
 

modules/core/doc/utility_and_system_functions_and_macros.rst

@@ -218,19 +218,19 @@ Exception class passed to an error. ::
     public:
         // various constructors and the copy operation
         Exception() { code = 0; line = 0; }
-        Exception(int _code, const string& _err,
-                  const string& _func, const string& _file, int _line);
+        Exception(int _code, const String& _err,
+                  const String& _func, const String& _file, int _line);
         Exception(const Exception& exc);
         Exception& operator = (const Exception& exc);
 
         // the error code
         int code;
         // the error text message
-        string err;
+        String err;
         // function name where the error happened
-        string func;
+        String func;
         // the source file name where the error happened
-        string file;
+        String file;
         // the source file line where the error happened
         int line;
     };
@@ -272,7 +272,7 @@ format
 ------
 Returns a text string formatted using the ``printf``\ -like expression.
 
-.. ocv:function:: string format( const char* fmt, ... )
+.. ocv:function:: String format( const char* fmt, ... )
 
     :param fmt: ``printf`` -compatible formatting specifiers.
 

modules/core/doc/xml_yaml_persistence.rst

@@ -156,7 +156,7 @@ The constructors.
 
 .. ocv:function:: FileStorage::FileStorage()
 
-.. ocv:function:: FileStorage::FileStorage(const string& source, int flags, const string& encoding=string())
+.. ocv:function:: FileStorage::FileStorage(const String& source, int flags, const String& encoding=String())
 
     :param source: Name of the file to open or the text string to read the data from. Extension of the file (``.xml`` or ``.yml``/``.yaml``) determines its format (XML or YAML respectively). Also you can append ``.gz`` to work with compressed files, for example ``myHugeMatrix.xml.gz``. If both ``FileStorage::WRITE`` and ``FileStorage::MEMORY`` flags are specified, ``source`` is used just to specify the output file format (e.g. ``mydata.xml``, ``.yml`` etc.).
 
@@ -179,7 +179,7 @@ FileStorage::open
 -----------------
 Opens a file.
 
-.. ocv:function:: bool FileStorage::open(const string& filename, int flags, const string& encoding=string())
+.. ocv:function:: bool FileStorage::open(const String& filename, int flags, const String& encoding=String())
 
 See description of parameters in :ocv:func:`FileStorage::FileStorage`. The method calls :ocv:func:`FileStorage::release` before opening the file.
 
@@ -208,7 +208,7 @@ FileStorage::releaseAndGetString
 --------------------------------
 Closes the file and releases all the memory buffers.
 
-.. ocv:function:: string FileStorage::releaseAndGetString()
+.. ocv:function:: String FileStorage::releaseAndGetString()
 
 Call this method after all I/O operations with the storage are finished. If the storage was opened for writing data and ``FileStorage::WRITE`` was specified
 
@@ -237,7 +237,7 @@ FileStorage::operator[]
 -----------------------
 Returns the specified element of the top-level mapping.
 
-.. ocv:function:: FileNode FileStorage::operator[](const string& nodename) const
+.. ocv:function:: FileNode FileStorage::operator[](const String& nodename) const
 
 .. ocv:function:: FileNode FileStorage::operator[](const char* nodename) const
 
@@ -261,7 +261,7 @@ FileStorage::writeRaw
 ---------------------
 Writes multiple numbers.
 
-.. ocv:function:: void FileStorage::writeRaw( const string& fmt, const uchar* vec, size_t len )
+.. ocv:function:: void FileStorage::writeRaw( const String& fmt, const uchar* vec, size_t len )
 
      :param fmt: Specification of each array element that has the following format  ``([count]{'u'|'c'|'w'|'s'|'i'|'f'|'d'})...`` where the characters correspond to fundamental C++ types:
 
@@ -293,7 +293,7 @@ FileStorage::writeObj
 ---------------------
 Writes the registered C structure (CvMat, CvMatND, CvSeq).
 
-.. ocv:function:: void FileStorage::writeObj( const string& name, const void* obj )
+.. ocv:function:: void FileStorage::writeObj( const String& name, const void* obj )
 
     :param name: Name of the written object.
 
@@ -306,7 +306,7 @@ FileStorage::getDefaultObjectName
 ---------------------------------
 Returns the normalized object name for the specified name of a file.
 
-.. ocv:function:: static string FileStorage::getDefaultObjectName(const string& filename)
+.. ocv:function:: static String FileStorage::getDefaultObjectName(const String& filename)
 
    :param filename: Name of a file
 
@@ -383,7 +383,7 @@ FileNode::operator[]
 --------------------
 Returns element of a mapping node or a sequence node.
 
-.. ocv:function:: FileNode FileNode::operator[](const string& nodename) const
+.. ocv:function:: FileNode FileNode::operator[](const String& nodename) const
 
 .. ocv:function:: FileNode FileNode::operator[](const char* nodename) const
 
@@ -507,7 +507,7 @@ FileNode::name
 --------------
 Returns the node name.
 
-.. ocv:function:: string FileNode::name() const
+.. ocv:function:: String FileNode::name() const
 
     :returns: The node name or an empty string if the node is nameless.
 
@@ -588,7 +588,7 @@ FileNode::readRaw
 -----------------
 Reads node elements to the buffer with the specified format.
 
-.. ocv:function:: void FileNode::readRaw( const string& fmt, uchar* vec, size_t len ) const
+.. ocv:function:: void FileNode::readRaw( const String& fmt, uchar* vec, size_t len ) const
 
     :param fmt: Specification of each array element. It has the same format as in :ocv:func:`FileStorage::writeRaw`.
 
@@ -692,7 +692,7 @@ FileNodeIterator::readRaw
 -------------------------
 Reads node elements to the buffer with the specified format.
 
-.. ocv:function:: FileNodeIterator& FileNodeIterator::readRaw( const string& fmt, uchar* vec, size_t maxCount=(size_t)INT_MAX )
+.. ocv:function:: FileNodeIterator& FileNodeIterator::readRaw( const String& fmt, uchar* vec, size_t maxCount=(size_t)INT_MAX )
 
     :param fmt: Specification of each array element. It has the same format as in :ocv:func:`FileStorage::writeRaw`.