mirror of
https://github.com/opencv/opencv.git
synced 2026-07-29 15:23:05 +04:00
Merge pull request #25161 from mshabunin:doc-upgrade-5.x
Documentation transition to fresh Doxygen (5.x) #25161 Port of #25042 Merge with opencv/opencv_contrib#3687 CI part: opencv/ci-gha-workflow#162
This commit is contained in:
@@ -41,6 +41,10 @@ G-API documentation is organized into the following chapters:
|
||||
|
||||
- API Reference: functions and classes
|
||||
|
||||
- @subpage gapi_ref
|
||||
|
||||
Core G-API classes, data types, backends, etc.
|
||||
|
||||
- @subpage gapi_core
|
||||
|
||||
Core G-API operations - arithmetic, boolean, and other matrix
|
||||
@@ -51,6 +55,14 @@ G-API documentation is organized into the following chapters:
|
||||
Image processing functions: color space conversions, various
|
||||
filters, etc.
|
||||
|
||||
- @subpage gapi_video
|
||||
|
||||
Video processing functionality.
|
||||
|
||||
- @subpage gapi_draw
|
||||
|
||||
Drawing and composition functionality
|
||||
|
||||
# API Example {#gapi_example}
|
||||
|
||||
A very basic example of G-API pipeline is shown below:
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
# G-API Implementation details
|
||||
|
||||
Note -- this section is still in progress.
|
||||
@note this section is still in progress.
|
||||
|
||||
# API layer {#gapi_detail_api}
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
#include <memory>
|
||||
|
||||
/** \defgroup gapi G-API framework
|
||||
/** \defgroup gapi_ref G-API framework
|
||||
@{
|
||||
@defgroup gapi_main_classes G-API Main Classes
|
||||
@defgroup gapi_data_objects G-API Data Types
|
||||
|
||||
@@ -249,6 +249,8 @@ template<typename T> struct wrap_serialize
|
||||
} // namespace s11n
|
||||
} // namespace gapi
|
||||
|
||||
/** @} gapi_compile_args */
|
||||
|
||||
/**
|
||||
* @brief Ask G-API to dump compiled graph in Graphviz format under
|
||||
* the given file name.
|
||||
@@ -261,7 +263,6 @@ struct graph_dump_path
|
||||
{
|
||||
std::string m_dump_path;
|
||||
};
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @brief Ask G-API to use threaded executor when cv::GComputation
|
||||
@@ -276,7 +277,6 @@ struct GAPI_EXPORTS use_threaded_executor
|
||||
|
||||
uint32_t num_threads;
|
||||
};
|
||||
/** @} */
|
||||
|
||||
namespace detail
|
||||
{
|
||||
|
||||
@@ -388,7 +388,6 @@ protected:
|
||||
/// @private
|
||||
std::shared_ptr<Priv> m_priv;
|
||||
};
|
||||
/** @} */
|
||||
|
||||
namespace gapi {
|
||||
|
||||
@@ -413,7 +412,6 @@ struct GAPI_EXPORTS_W_SIMPLE queue_capacity
|
||||
GAPI_PROP_RW
|
||||
size_t capacity;
|
||||
};
|
||||
/** @} */
|
||||
} // namespace streaming
|
||||
} // namespace gapi
|
||||
|
||||
@@ -425,6 +423,8 @@ template<> struct CompileArgTag<cv::gapi::streaming::queue_capacity>
|
||||
};
|
||||
}
|
||||
|
||||
/** @} gapi_main_classes */
|
||||
|
||||
}
|
||||
|
||||
#endif // OPENCV_GAPI_GSTREAMING_COMPILED_HPP
|
||||
|
||||
@@ -690,7 +690,6 @@ namespace wip { namespace ov {
|
||||
* taking into account the i/o data transfer.
|
||||
*/
|
||||
struct benchmark_mode { };
|
||||
/** @} */
|
||||
|
||||
} // namespace ov
|
||||
} // namespace wip
|
||||
|
||||
Reference in New Issue
Block a user