Merge remote-tracking branch 'upstream/3.4' into merge-3.4

samples/cpp/tutorial_code/core/file_input_output/file_input_output.cpp

@@ -25,6 +25,7 @@ public:
     {}
     explicit MyData(int) : A(97), X(CV_PI), id("mydata1234") // explicit to avoid implicit conversion
     {}
+    //! [inside]
     void write(FileStorage& fs) const                        //Write serialization for this class
     {
         fs << "{" << "A" << A << "X" << X << "id" << id << "}";
@@ -35,6 +36,7 @@ public:
         X = (double)node["X"];
         id = (string)node["id"];
     }
+    //! [inside]
 public:   // Data Members
     int A;
     double X;
@@ -42,6 +44,7 @@ public:   // Data Members
 };
 
 //These write and read functions must be defined for the serialization in FileStorage to work
+//! [outside]
 static void write(FileStorage& fs, const std::string&, const MyData& x)
 {
     x.write(fs);
@@ -52,6 +55,7 @@ static void read(const FileNode& node, MyData& x, const MyData& default_value =
     else
         x.read(node);
 }
+//! [outside]
 
 // This function will print our custom class to the console
 static ostream& operator<<(ostream& out, const MyData& m)
@@ -72,27 +76,48 @@ int main(int ac, char** av)
 
     string filename = av[1];
     { //write
+        //! [iomati]
         Mat R = Mat_<uchar>::eye(3, 3),
             T = Mat_<double>::zeros(3, 1);
+        //! [iomati]
+        //! [customIOi]
         MyData m(1);
+        //! [customIOi]
 
+        //! [open]
         FileStorage fs(filename, FileStorage::WRITE);
+        // or:
+        // FileStorage fs;
+        // fs.open(filename, FileStorage::WRITE);
+        //! [open]
 
+        //! [writeNum]
         fs << "iterationNr" << 100;
+        //! [writeNum]
+        //! [writeStr]
         fs << "strings" << "[";                              // text - string sequence
         fs << "image1.jpg" << "Awesomeness" << "../data/baboon.jpg";
         fs << "]";                                           // close sequence
+        //! [writeStr]
 
+        //! [writeMap]
         fs << "Mapping";                              // text - mapping
         fs << "{" << "One" << 1;
         fs <<        "Two" << 2 << "}";
+        //! [writeMap]
 
+        //! [iomatw]
         fs << "R" << R;                                      // cv::Mat
         fs << "T" << T;
+        //! [iomatw]
 
+        //! [customIOw]
         fs << "MyData" << m;                                // your own data structures
+        //! [customIOw]
 
+        //! [close]
         fs.release();                                       // explicit close
+        //! [close]
         cout << "Write Done." << endl;
     }
 
@@ -101,9 +126,11 @@ int main(int ac, char** av)
         FileStorage fs;
         fs.open(filename, FileStorage::READ);
 
+        //! [readNum]
         int itNr;
         //fs["iterationNr"] >> itNr;
         itNr = (int) fs["iterationNr"];
+        //! [readNum]
         cout << itNr;
         if (!fs.isOpened())
         {
@@ -112,6 +139,7 @@ int main(int ac, char** av)
             return 1;
         }
 
+        //! [readStr]
         FileNode n = fs["strings"];                         // Read string sequence - Get node
         if (n.type() != FileNode::SEQ)
         {
@@ -122,19 +150,26 @@ int main(int ac, char** av)
         FileNodeIterator it = n.begin(), it_end = n.end(); // Go through the node
         for (; it != it_end; ++it)
             cout << (string)*it << endl;
+        //! [readStr]
 
 
+        //! [readMap]
         n = fs["Mapping"];                                // Read mappings from a sequence
         cout << "Two  " << (int)(n["Two"]) << "; ";
         cout << "One  " << (int)(n["One"]) << endl << endl;
+        //! [readMap]
 
 
         MyData m;
         Mat R, T;
 
+        //! [iomat]
         fs["R"] >> R;                                      // Read cv::Mat
         fs["T"] >> T;
+        //! [iomat]
+        //! [customIO]
         fs["MyData"] >> m;                                 // Read your own structure_
+        //! [customIO]
 
         cout << endl
             << "R = " << R << endl;
@@ -142,9 +177,11 @@ int main(int ac, char** av)
         cout << "MyData = " << endl << m << endl << endl;
 
         //Show default behavior for non existing nodes
+        //! [nonexist]
         cout << "Attempt to read NonExisting (should initialize the data structure with its default).";
         fs["NonExisting"] >> m;
         cout << endl << "NonExisting = " << endl << m << endl;
+        //! [nonexist]
     }
 
     cout << endl