1
0
mirror of https://github.com/opencv/opencv.git synced 2026-07-29 23:33:05 +04:00

Merge pull request #25042 from mshabunin:doc-upgrade

Documentation transition to fresh Doxygen #25042

* current Doxygen version is 1.10, but we will use 1.9.8 for now due to issue with snippets (https://github.com/doxygen/doxygen/pull/10584)
* Doxyfile adapted to new version
* MathJax updated to 3.x
* `@relates` instructions removed temporarily due to issue in Doxygen (to avoid warnings)
* refactored matx.hpp - extracted matx.inl.hpp
* opencv_contrib - https://github.com/opencv/opencv_contrib/pull/3638
This commit is contained in:
Maksim Shabunin
2024-03-05 16:19:45 +03:00
committed by GitHub
parent 0f5792a7a1
commit bf06e3d09f
49 changed files with 1764 additions and 1658 deletions
+13 -1
View File
@@ -17,7 +17,7 @@ is volatile at the moment and there may be minor but
compatibility-breaking changes in the future.
# Contents
gapi
G-API documentation is organized into the following chapters:
- @subpage gapi_purposes
@@ -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:
+1 -1
View File
@@ -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}
+1 -1
View File
@@ -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