Skip to content

Commit 12f9764

Browse files
committed
doc: reformat group definitions
1 parent 6036579 commit 12f9764

File tree

8 files changed

+40
-53
lines changed

8 files changed

+40
-53
lines changed

Diff for: modules/cannops/include/opencv2/cann.hpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
#include "opencv2/core.hpp"
99

1010
/**
11-
@defgroup cann Ascend-accelerated Computer Vision
11+
@defgroup cannops Ascend-accelerated Computer Vision
1212
@{
1313
@defgroup canncore Core part
1414
@{
1515
@defgroup cann_struct Data Structures
16-
@defgroup cann_init Initializeation and Information
16+
@defgroup cann_init Initialization and Information
1717
@}
1818
@}
1919
*/

Diff for: modules/cannops/include/opencv2/cann_interface.hpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ namespace cann
1313
{
1414

1515
/**
16-
@addtogroup cann
16+
@addtogroup cannops
1717
@{
18-
@defgroup cannops Operations for Ascend Backend.
18+
@defgroup cannops_ops Operations for Ascend Backend.
1919
@{
2020
@defgroup cannops_elem Per-element Operations
2121
@defgroup cannops_core Core Operations on Matrices

Diff for: modules/face/include/opencv2/face/facemark.hpp

+3-6
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,15 @@ Mentor: Delia Passalacqua
1212
#ifndef __OPENCV_FACELANDMARK_HPP__
1313
#define __OPENCV_FACELANDMARK_HPP__
1414

15-
/**
16-
@defgroup face Face Analysis
17-
- @ref tutorial_table_of_content_facemark
18-
- The Facemark API
19-
*/
20-
2115
#include "opencv2/core.hpp"
2216
#include <vector>
2317

2418

2519
namespace cv {
2620
namespace face {
2721

22+
//! @addtogroup face
23+
//! @{
2824

2925
/** @brief Abstract base class for all facemark models
3026
@@ -88,6 +84,7 @@ CV_EXPORTS_W Ptr<Facemark> createFacemarkLBF();
8884
//! construct a Kazemi facemark detector
8985
CV_EXPORTS_W Ptr<Facemark> createFacemarkKazemi();
9086

87+
//! @}
9188

9289
} // face
9390
} // cv

Diff for: modules/face/include/opencv2/face/facemark_train.hpp

-6
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@ Mentor: Delia Passalacqua
1212
#ifndef __OPENCV_FACELANDMARKTRAIN_HPP__
1313
#define __OPENCV_FACELANDMARKTRAIN_HPP__
1414

15-
/**
16-
@defgroup face Face Analysis
17-
- @ref tutorial_table_of_content_facemark
18-
- The Facemark API
19-
*/
20-
2115
#include "opencv2/face/facemark.hpp"
2216
#include "opencv2/objdetect.hpp"
2317
#include <vector>

Diff for: modules/fuzzy/include/opencv2/fuzzy.hpp

+5-5
Original file line numberDiff line numberDiff line change
@@ -52,19 +52,19 @@
5252
5353
Namespace for all functions is `ft`. The module brings implementation of the last image processing algorithms based on fuzzy mathematics. Method are named based on the pattern `FT`_degree_dimension`_`method.
5454
55-
@{
55+
@{
5656
@defgroup f0_math Math with F0-transform support
5757
58-
Fuzzy transform (\f$F^0\f$-transform) of the 0th degree transforms whole image to a matrix of its components. These components are used in latter computation where each of them represents average color of certain subarea.
58+
Fuzzy transform (\f$F^0\f$-transform) of the 0th degree transforms whole image to a matrix of its components. These components are used in latter computation where each of them represents average color of certain subarea.
5959
6060
@defgroup f1_math Math with F1-transform support
6161
62-
Fuzzy transform (\f$F^1\f$-transform) of the 1th degree transforms whole image to a matrix of its components. Each component is polynomial of the 1th degree carrying information about average color and average gradient of certain subarea.
62+
Fuzzy transform (\f$F^1\f$-transform) of the 1th degree transforms whole image to a matrix of its components. Each component is polynomial of the 1th degree carrying information about average color and average gradient of certain subarea.
6363
6464
@defgroup f_image Fuzzy image processing
6565
66-
Image proceesing based on fuzzy mathematics namely F-transform.
67-
@}
66+
Image proceesing based on fuzzy mathematics namely F-transform.
67+
@}
6868
6969
*/
7070

Diff for: modules/hdf/include/opencv2/hdf.hpp

+6-8
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,15 @@
4141
4242
This module provides storage routines for Hierarchical Data Format objects.
4343
44-
@{
44+
@{
4545
@defgroup hdf5 Hierarchical Data Format version 5
4646
47-
Hierarchical Data Format version 5
48-
--------------------------------------------------------
47+
Hierarchical Data Format version 5
48+
--------------------------------------------------------
4949
50-
In order to use it, the hdf5 library has to be installed, which
51-
means cmake should find it using `find_package(HDF5)` .
52-
53-
54-
@}
50+
In order to use it, the hdf5 library has to be installed, which
51+
means cmake should find it using `find_package(HDF5)`.
52+
@}
5553
*/
5654

5755
#endif

Diff for: modules/sfm/include/opencv2/sfm.hpp

+8-9
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ This module has been originally developed as a project for Google Summer of Code
7575
- Notice that it is compiled only when Eigen, GLog and GFlags are correctly installed.\n
7676
Check installation instructions in the following tutorial: @ref tutorial_sfm_installation
7777
78-
@{
78+
@{
7979
@defgroup conditioning Conditioning
8080
@defgroup fundamental Fundamental
8181
@defgroup io Input/Output
@@ -85,18 +85,17 @@ This module has been originally developed as a project for Google Summer of Code
8585
@defgroup triangulation Triangulation
8686
8787
@defgroup reconstruction Reconstruction
88-
@note
89-
- Notice that it is compiled only when Ceres Solver is correctly installed.\n
90-
Check installation instructions in the following tutorial: @ref tutorial_sfm_installation
9188
89+
@note
90+
- Notice that it is compiled only when Ceres Solver is correctly installed.\n
91+
Check installation instructions in the following tutorial: @ref tutorial_sfm_installation
9292
9393
@defgroup simple_pipeline Simple Pipeline
94-
@note
95-
- Notice that it is compiled only when Ceres Solver is correctly installed.\n
96-
Check installation instructions in the following tutorial: @ref tutorial_sfm_installation
97-
98-
@}
9994
95+
@note
96+
- Notice that it is compiled only when Ceres Solver is correctly installed.\n
97+
Check installation instructions in the following tutorial: @ref tutorial_sfm_installation
98+
@}
10099
*/
101100

102101
#endif

Diff for: modules/viz/include/opencv2/viz.hpp

+14-15
Original file line numberDiff line numberDiff line change
@@ -60,25 +60,24 @@ interact with it.
6060
3D visualization window (see Viz3d) is used to display widgets (see Widget), and it provides several
6161
methods to interact with scene and widgets.
6262
63-
@{
63+
@{
6464
@defgroup viz_widget Widget
6565
66-
In this section, the widget framework is explained. Widgets represent 2D or 3D objects, varying from
67-
simple ones such as lines to complex ones such as point clouds and meshes.
66+
In this section, the widget framework is explained. Widgets represent 2D or 3D objects, varying from
67+
simple ones such as lines to complex ones such as point clouds and meshes.
6868
69-
Widgets are **implicitly shared**. Therefore, one can add a widget to the scene, and modify the
70-
widget without re-adding the widget.
69+
Widgets are **implicitly shared**. Therefore, one can add a widget to the scene, and modify the
70+
widget without re-adding the widget.
7171
72-
@code
73-
// Create a cloud widget
74-
viz::WCloud cw(cloud, viz::Color::red());
75-
// Display it in a window
76-
myWindow.showWidget("CloudWidget1", cw);
77-
// Modify it, and it will be modified in the window.
78-
cw.setColor(viz::Color::yellow());
79-
@endcode
80-
81-
@}
72+
@code
73+
// Create a cloud widget
74+
viz::WCloud cw(cloud, viz::Color::red());
75+
// Display it in a window
76+
myWindow.showWidget("CloudWidget1", cw);
77+
// Modify it, and it will be modified in the window.
78+
cw.setColor(viz::Color::yellow());
79+
@endcode
80+
@}
8281
*/
8382

8483
#endif /* OPENCV_VIZ_HPP */

0 commit comments

Comments
 (0)