Merge pull request #20857 from alexgiving:atrutnev/move_API_samples

Trutnev Aleksei · web-flow · commit b525480b256f · 2021-11-12T14:17:21.000Z
Move API sample code to tutorial_code location
diff --git a/modules/gapi/doc/20-kernel-api.markdown b/modules/gapi/doc/20-kernel-api.markdown
@@ -47,7 +47,7 @@ an external parameter.
 G-API provides a macro to define a new kernel interface --
 G_TYPED_KERNEL():
 
-@snippet modules/gapi/samples/kernel_api_snippets.cpp filter2d_api
+@snippet samples/cpp/tutorial_code/gapi/doc_snippets/kernel_api_snippets.cpp filter2d_api
 
 This macro is a shortcut to a new type definition. It takes three
 arguments to register a new type, and requires type body to be present
@@ -81,18 +81,18 @@ Once a kernel is defined, it can be used in pipelines with special,
 G-API-supplied method "::on()". This method has the same signature as
 defined in kernel, so this code:
 
-@snippet modules/gapi/samples/kernel_api_snippets.cpp filter2d_on
+@snippet samples/cpp/tutorial_code/gapi/doc_snippets/kernel_api_snippets.cpp filter2d_on
 
 is a perfectly legal construction. This example has some verbosity,
 though, so usually a kernel declaration comes with a C++ function
 wrapper ("factory method") which enables optional parameters, more
 compact syntax, Doxygen comments, etc:
 
-@snippet modules/gapi/samples/kernel_api_snippets.cpp filter2d_wrap
+@snippet samples/cpp/tutorial_code/gapi/doc_snippets/kernel_api_snippets.cpp filter2d_wrap
 
 so now it can be used like:
 
-@snippet modules/gapi/samples/kernel_api_snippets.cpp filter2d_wrap_call
+@snippet samples/cpp/tutorial_code/gapi/doc_snippets/kernel_api_snippets.cpp filter2d_wrap_call
 
 # Extra information {#gapi_kernel_supp_info}
 
@@ -143,7 +143,7 @@ For example, the aforementioned `Filter2D` is implemented in
 "reference" CPU (OpenCV) plugin this way (*NOTE* -- this is a
 simplified form with improper border handling):
 
-@snippet modules/gapi/samples/kernel_api_snippets.cpp filter2d_ocv
+@snippet samples/cpp/tutorial_code/gapi/doc_snippets/kernel_api_snippets.cpp filter2d_ocv
 
 Note how CPU (OpenCV) plugin has transformed the original kernel
 signature:
@@ -174,7 +174,7 @@ point extraction to an STL vector:
 A compound kernel _implementation_ can be defined using a generic
 macro GAPI_COMPOUND_KERNEL():
 
-@snippet modules/gapi/samples/kernel_api_snippets.cpp compound
+@snippet samples/cpp/tutorial_code/gapi/doc_snippets/kernel_api_snippets.cpp compound
 
 <!-- TODO: ADD on how Compound kernels may simplify dispatching -->
 <!-- TODO: Add details on when expand() is called! -->
diff --git a/modules/gapi/include/opencv2/gapi/garg.hpp b/modules/gapi/include/opencv2/gapi/garg.hpp
@@ -171,7 +171,7 @@ using GRunArgs = std::vector<GRunArg>;
  * It's an ordinary overload of addition assignment operator.
  *
  * Example of usage:
- * @snippet modules/gapi/samples/dynamic_graph.cpp GRunArgs usage
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/dynamic_graph_snippets.cpp GRunArgs usage
  *
  */
 inline GRunArgs& operator += (GRunArgs &lhs, const GRunArgs &rhs)
@@ -223,7 +223,7 @@ using GRunArgsP = std::vector<GRunArgP>;
  * It's an ordinary overload of addition assignment operator.
  *
  * Example of usage:
- * @snippet modules/gapi/samples/dynamic_graph.cpp GRunArgsP usage
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/dynamic_graph_snippets.cpp GRunArgsP usage
  *
  */
 inline GRunArgsP& operator += (GRunArgsP &lhs, const GRunArgsP &rhs)
@@ -247,7 +247,7 @@ namespace gapi
  * it needs to be wrapped by this function.
  *
  * Example of usage:
- * @snippet modules/gapi/samples/api_ref_snippets.cpp bind after deserialization
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp bind after deserialization
  *
  * @param out_args deserialized GRunArgs.
  * @return the same GRunArgs wrapped in GRunArgsP.
@@ -260,7 +260,7 @@ GAPI_EXPORTS cv::GRunArgsP bind(cv::GRunArgs &out_args);
  * which this function does.
  *
  * Example of usage:
- * @snippet modules/gapi/samples/api_ref_snippets.cpp bind before serialization
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp bind before serialization
  *
  * @param out output GRunArgsP available during graph execution.
  * @return the same GRunArgsP wrapped in serializable GRunArgs.
diff --git a/modules/gapi/include/opencv2/gapi/gcommon.hpp b/modules/gapi/include/opencv2/gapi/gcommon.hpp
@@ -134,12 +134,12 @@ namespace detail {
  *
  * For example, if an example computation is executed like this:
  *
- * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_decl_apply
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_decl_apply
  *
  * Extra parameter specifying which kernels to compile with can be
  * passed like this:
  *
- * @snippet modules/gapi/samples/api_ref_snippets.cpp apply_with_param
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp apply_with_param
  */
 
 /**
diff --git a/modules/gapi/include/opencv2/gapi/gcomputation.hpp b/modules/gapi/include/opencv2/gapi/gcomputation.hpp
@@ -61,11 +61,11 @@ namespace s11n {
  * executed. The below example expresses calculation of Sobel operator
  * for edge detection (\f$G = \sqrt{G_x^2 + G_y^2}\f$):
  *
- * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_def
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_def
  *
  * Full pipeline can be now captured with this object declaration:
  *
- * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_cap_full
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_cap_full
  *
  * Input/output data objects on which a call graph should be
  * reconstructed are passed using special wrappers cv::GIn and
@@ -78,7 +78,7 @@ namespace s11n {
  * expects that image gradients are already pre-calculated may be
  * defined like this:
  *
- * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_cap_sub
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_cap_sub
  *
  * The resulting graph would expect two inputs and produce one
  * output. In this case, it doesn't matter if gx/gy data objects are
@@ -130,7 +130,7 @@ class GAPI_EXPORTS_W GComputation
      * Graph can be defined in-place directly at the moment of its
      * construction with a lambda:
      *
-     * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_gen
+     * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_gen
      *
      * This may be useful since all temporary objects (cv::GMats) and
      * namespaces can be localized to scope of lambda, without
diff --git a/modules/gapi/include/opencv2/gapi/gkernel.hpp b/modules/gapi/include/opencv2/gapi/gkernel.hpp
@@ -659,7 +659,7 @@ namespace gapi {
      * Use this function to pass kernel implementations (defined in
      * either way) and transformations to the system. Example:
      *
-     * @snippet modules/gapi/samples/api_ref_snippets.cpp kernels_snippet
+     * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp kernels_snippet
      *
      * Note that kernels() itself is a function returning object, not
      * a type, so having `()` at the end is important -- it must be a
diff --git a/modules/gapi/include/opencv2/gapi/gproto.hpp b/modules/gapi/include/opencv2/gapi/gproto.hpp
@@ -71,7 +71,7 @@ struct GIOProtoArgs
      * It's an ordinary overload of addition assignment operator.
      *
      * Example of usage:
-     * @snippet modules/gapi/samples/dynamic_graph.cpp  GIOProtoArgs usage
+     * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/dynamic_graph_snippets.cpp  GIOProtoArgs usage
      *
      */
     template<typename Tg>
diff --git a/modules/gapi/include/opencv2/gapi/gscalar.hpp b/modules/gapi/include/opencv2/gapi/gscalar.hpp
@@ -88,7 +88,7 @@ class GAPI_EXPORTS_W_SIMPLE GScalar
      * This constructor overload is not marked `explicit` and can be
      * used in G-API expression code like this:
      *
-     * @snippet modules/gapi/samples/api_ref_snippets.cpp gscalar_implicit
+     * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp gscalar_implicit
      *
      * Here operator+(GMat,GScalar) is used to wrap cv::gapi::addC()
      * and a value-initialized GScalar is created on the fly.
diff --git a/modules/gapi/include/opencv2/gapi/gtyped.hpp b/modules/gapi/include/opencv2/gapi/gtyped.hpp
@@ -57,7 +57,7 @@ namespace detail
  *
  *  Refer to the following example. Regular (untyped) code is written this way:
  *
- *  @snippet modules/gapi/samples/api_ref_snippets.cpp Untyped_Example
+ *  @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp Untyped_Example
  *
  *  Here:
  *
@@ -71,7 +71,7 @@ namespace detail
  *
  *  Now the same code written with typed API:
  *
- *  @snippet modules/gapi/samples/api_ref_snippets.cpp Typed_Example
+ *  @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp Typed_Example
  *
  *  The key difference is:
  *
diff --git a/modules/gapi/include/opencv2/gapi/s11n/base.hpp b/modules/gapi/include/opencv2/gapi/s11n/base.hpp
@@ -40,7 +40,7 @@ struct NotImplemented {
  * which can be utilized when serializing a custom type.
  *
  * Example of usage:
- * @snippet modules/gapi/samples/api_ref_snippets.cpp S11N usage
+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp S11N usage
  *
  */
 template<typename T>
diff --git a/samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp b/samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp
diff --git a/samples/cpp/tutorial_code/gapi/doc_snippets/dynamic_graph_snippets.cpp b/samples/cpp/tutorial_code/gapi/doc_snippets/dynamic_graph_snippets.cpp
diff --git a/samples/cpp/tutorial_code/gapi/doc_snippets/kernel_api_snippets.cpp b/samples/cpp/tutorial_code/gapi/doc_snippets/kernel_api_snippets.cpp

Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ using GRunArgs = std::vector<GRunArg>;`
`171`	`171`	`* It's an ordinary overload of addition assignment operator.`
`172`	`172`	`*`
`173`	`173`	`* Example of usage:`
`174`		`- * @snippet modules/gapi/samples/dynamic_graph.cpp GRunArgs usage`
	`174`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/dynamic_graph_snippets.cpp GRunArgs usage`
`175`	`175`	`*`
`176`	`176`	`*/`
`177`	`177`	`inline GRunArgs& operator += (GRunArgs &lhs, const GRunArgs &rhs)`
`@@ -223,7 +223,7 @@ using GRunArgsP = std::vector<GRunArgP>;`
`223`	`223`	`* It's an ordinary overload of addition assignment operator.`
`224`	`224`	`*`
`225`	`225`	`* Example of usage:`
`226`		`- * @snippet modules/gapi/samples/dynamic_graph.cpp GRunArgsP usage`
	`226`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/dynamic_graph_snippets.cpp GRunArgsP usage`
`227`	`227`	`*`
`228`	`228`	`*/`
`229`	`229`	`inline GRunArgsP& operator += (GRunArgsP &lhs, const GRunArgsP &rhs)`
`@@ -247,7 +247,7 @@ namespace gapi`
`247`	`247`	`* it needs to be wrapped by this function.`
`248`	`248`	`*`
`249`	`249`	`* Example of usage:`
`250`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp bind after deserialization`
	`250`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp bind after deserialization`
`251`	`251`	`*`
`252`	`252`	`* @param out_args deserialized GRunArgs.`
`253`	`253`	`* @return the same GRunArgs wrapped in GRunArgsP.`
`@@ -260,7 +260,7 @@ GAPI_EXPORTS cv::GRunArgsP bind(cv::GRunArgs &out_args);`
`260`	`260`	`* which this function does.`
`261`	`261`	`*`
`262`	`262`	`* Example of usage:`
`263`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp bind before serialization`
	`263`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp bind before serialization`
`264`	`264`	`*`
`265`	`265`	`* @param out output GRunArgsP available during graph execution.`
`266`	`266`	`* @return the same GRunArgsP wrapped in serializable GRunArgs.`
Original file line number	Diff line number	Diff line change
`@@ -134,12 +134,12 @@ namespace detail {`
`134`	`134`	`*`
`135`	`135`	`* For example, if an example computation is executed like this:`
`136`	`136`	`*`
`137`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_decl_apply`
	`137`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_decl_apply`
`138`	`138`	`*`
`139`	`139`	`* Extra parameter specifying which kernels to compile with can be`
`140`	`140`	`* passed like this:`
`141`	`141`	`*`
`142`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp apply_with_param`
	`142`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp apply_with_param`
`143`	`143`	`*/`
`144`	`144`
`145`	`145`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -61,11 +61,11 @@ namespace s11n {`
`61`	`61`	`* executed. The below example expresses calculation of Sobel operator`
`62`	`62`	`* for edge detection (\f$G = \sqrt{G_x^2 + G_y^2}\f$):`
`63`	`63`	`*`
`64`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_def`
	`64`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_def`
`65`	`65`	`*`
`66`	`66`	`* Full pipeline can be now captured with this object declaration:`
`67`	`67`	`*`
`68`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_cap_full`
	`68`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_cap_full`
`69`	`69`	`*`
`70`	`70`	`* Input/output data objects on which a call graph should be`
`71`	`71`	`* reconstructed are passed using special wrappers cv::GIn and`
`@@ -78,7 +78,7 @@ namespace s11n {`
`78`	`78`	`* expects that image gradients are already pre-calculated may be`
`79`	`79`	`* defined like this:`
`80`	`80`	`*`
`81`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_cap_sub`
	`81`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_cap_sub`
`82`	`82`	`*`
`83`	`83`	`* The resulting graph would expect two inputs and produce one`
`84`	`84`	`* output. In this case, it doesn't matter if gx/gy data objects are`
`@@ -130,7 +130,7 @@ class GAPI_EXPORTS_W GComputation`
`130`	`130`	`* Graph can be defined in-place directly at the moment of its`
`131`	`131`	`* construction with a lambda:`
`132`	`132`	`*`
`133`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp graph_gen`
	`133`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp graph_gen`
`134`	`134`	`*`
`135`	`135`	`* This may be useful since all temporary objects (cv::GMats) and`
`136`	`136`	`* namespaces can be localized to scope of lambda, without`
Original file line number	Diff line number	Diff line change
`@@ -659,7 +659,7 @@ namespace gapi {`
`659`	`659`	`* Use this function to pass kernel implementations (defined in`
`660`	`660`	`* either way) and transformations to the system. Example:`
`661`	`661`	`*`
`662`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp kernels_snippet`
	`662`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp kernels_snippet`
`663`	`663`	`*`
`664`	`664`	`* Note that kernels() itself is a function returning object, not`
`665`	`665`	* a type, so having `()` at the end is important -- it must be a
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ struct GIOProtoArgs`
`71`	`71`	`* It's an ordinary overload of addition assignment operator.`
`72`	`72`	`*`
`73`	`73`	`* Example of usage:`
`74`		`- * @snippet modules/gapi/samples/dynamic_graph.cpp GIOProtoArgs usage`
	`74`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/dynamic_graph_snippets.cpp GIOProtoArgs usage`
`75`	`75`	`*`
`76`	`76`	`*/`
`77`	`77`	`template<typename Tg>`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ class GAPI_EXPORTS_W_SIMPLE GScalar`
`88`	`88`	* This constructor overload is not marked `explicit` and can be
`89`	`89`	`* used in G-API expression code like this:`
`90`	`90`	`*`
`91`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp gscalar_implicit`
	`91`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp gscalar_implicit`
`92`	`92`	`*`
`93`	`93`	`* Here operator+(GMat,GScalar) is used to wrap cv::gapi::addC()`
`94`	`94`	`* and a value-initialized GScalar is created on the fly.`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ namespace detail`
`57`	`57`	`*`
`58`	`58`	`* Refer to the following example. Regular (untyped) code is written this way:`
`59`	`59`	`*`
`60`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp Untyped_Example`
	`60`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp Untyped_Example`
`61`	`61`	`*`
`62`	`62`	`* Here:`
`63`	`63`	`*`
`@@ -71,7 +71,7 @@ namespace detail`
`71`	`71`	`*`
`72`	`72`	`* Now the same code written with typed API:`
`73`	`73`	`*`
`74`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp Typed_Example`
	`74`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp Typed_Example`
`75`	`75`	`*`
`76`	`76`	`* The key difference is:`
`77`	`77`	`*`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ struct NotImplemented {`
`40`	`40`	`* which can be utilized when serializing a custom type.`
`41`	`41`	`*`
`42`	`42`	`* Example of usage:`
`43`		`- * @snippet modules/gapi/samples/api_ref_snippets.cpp S11N usage`
	`43`	`+ * @snippet samples/cpp/tutorial_code/gapi/doc_snippets/api_ref_snippets.cpp S11N usage`
`44`	`44`	`*`
`45`	`45`	`*/`
`46`	`46`	`template<typename T>`