6/10/2023 0 Comments Doxygen link to class![]() ![]() ![]() And of course these steps are just basic guidelines, there is always a place for creativity. usedfiles Represents the list of files from which documentation for the class was extracted. ![]() Represents the link to the list of all members for a class. It is not necessary to do things in the same order, but some steps really depend on previous. This file contain the link to and the body and html end tags. Steps described in this section can be used as checklist during documentation writing. Once the publication have been found - follow its "Cite" link and then choose "BibTeX" option: Note To get BibTeX record for the publications one can use Google Scholar. Then make reference with cite command: Bradski98 Note Try not to add publication duplicates because it can confuse documentation readers and writers later. You can assign a unique identifier to any header to reference it from other places. ĭoxygen comment can have different forms: C-style: reference item looks like this:ĭoxygen commands starts with or \ sign. command param denotes following word is name of the parameter and following text is description of the parameter all parameters are placed in a list command sa starts "See also" paragraph containing references to some classes, methods, pages or URLs.command brief denotes following paragraph is a brief description empty line denotes paragraph end.special C-comment syntax denotes it is doxygen comment /**.Special values (NaN, Inf) are not src input dst output array of the same size and type as log, cartToPolar, polarToCart, phase, pow, sqrt, magnitudeĬV_EXPORTS_W void exp(InputArray src, OutputArray dst) Currently, the function converts denormalized values to zeros on output. The maximum relative error is about 7e-6 for single-precision input and less than 1e-10 forĭouble-precision input. The function exp calculates the exponent of every element of the input array: Like this: /** Calculates the exponent of every array element. To add documentation for functions, classes and other entities, just insert special comment prior its definition. └── tutorials - tutorial pages and images All science books, articles and proceedings served as basis for library functionality should be put in this reference list.įollowing scheme represents common documentation places for opencv repository: BibTeX references are used to create one common bibliography.Parts of these files can be included into documentation and tutorials to demonstrate function calls and objects collaboration. Each sample is self-contained file which represents one simple application. code examples show how to use the library in real applications.Usually located at the same places as pages, images can be inserted to any place of the documentation. images can be used to illustrate described things.Pages should be located in separate files and contained in several predefined places. pages are good place to put big pieces of text with images and code examples not directly connected with any source code entity.source code entities, like classes, functions or enumerations, should be documented in corresponding header files, right prior entity definition.Whole documentation is gathered from many different places: Quick start Note These instructions are specific to OpenCV library documentation, other projects can use different layout scheme and documenting agreements. ![]()
0 Comments
Leave a Reply. |