generic-library/opencv
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fixed some mistakes

Browse Source
This commit is contained in:
Maksim Shabunin 2014-12-22 17:21:37 +03:00
parent 637b615e08
commit 06c2a70c49
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/tutorials/introduction/documenting_opencv/documentation_tutorial.markdown
View File

@ -441,7 +441,7 @@ _snippet_ command, since this method is less affected by the changes in processe
### Grouping commands {#tutorial_documentation_commands_group} ### Grouping commands {#tutorial_documentation_commands_group}
All code entities should be put into named groups representing OpenCV modules and thier internal All code entities should be put into named groups representing OpenCV modules and their internal
structure, thus each module should be associated with a group with the same name. Good place to structure, thus each module should be associated with a group with the same name. Good place to
define groups and subgroups is the main header file for this module: define groups and subgroups is the main header file for this module:
<em>"<module>/include/opencv2/<module>.hpp"</em>. <em>"<module>/include/opencv2/<module>.hpp"</em>.
@ -540,7 +540,7 @@ Write the tutorial {#tutorial_documentation_steps_tutorial}
representing performance or even a video. representing performance or even a video.
Save it in appropriate format for later use in the tutorial: Save it in appropriate format for later use in the tutorial:
- To save simple graph-like images use loseless ".png" format. - To save simple graph-like images use lossless ".png" format.
- For photo-like images - lossy ".jpg" format. - For photo-like images - lossy ".jpg" format.
- Numbers will be inserted as plain text, possibly formatted as table. - Numbers will be inserted as plain text, possibly formatted as table.
- Video should be uploaded on YouTube. - Video should be uploaded on YouTube.
@ -587,7 +587,7 @@ Write the tutorial {#tutorial_documentation_steps_tutorial}
authors list and short description. Also note the list item indent, empty lines between authors list and short description. Also note the list item indent, empty lines between
paragraphs and special _italic_ markers. paragraphs and special _italic_ markers.
7. Generate doxygen doumentation and verify results. 7. Generate doxygen documentation and verify results.
References {#tutorial_documentation_refs} References {#tutorial_documentation_refs}
========== ==========
@ -596,7 +596,7 @@ References {#tutorial_documentation_refs}
- [Markdown support] - supported syntax and extensions - [Markdown support] - supported syntax and extensions
- [Formulas support] - how to include formulas - [Formulas support] - how to include formulas
- [Supported formula commands] - HTML formulas use MathJax script for rendering - [Supported formula commands] - HTML formulas use MathJax script for rendering
- [Command reference] - supported commands and thier parameters - [Command reference] - supported commands and their parameters
<!-- invisible references list --> <!-- invisible references list -->
[Doxygen]: http://www.stack.nl/~dimitri/doxygen/index.html) [Doxygen]: http://www.stack.nl/~dimitri/doxygen/index.html)