Basic doxygen documentation support
- updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings Conflicts: CMakeLists.txt doc/CMakeLists.txt modules/core/include/opencv2/core.hpp modules/core/include/opencv2/core/base.hpp modules/core/include/opencv2/core/cuda.inl.hpp modules/core/include/opencv2/core/mat.hpp modules/core/include/opencv2/core/matx.hpp modules/core/include/opencv2/core/types.hpp modules/flann/include/opencv2/flann/lsh_table.h modules/imgproc/include/opencv2/imgproc.hpp
This commit is contained in:
@@ -664,6 +664,7 @@ namespace cv
|
||||
*\param center the transformation center: where the output precision is maximal
|
||||
*\param R the number of rings of the cortical image (default value 70 pixel)
|
||||
*\param ro0 the radius of the blind spot (default value 3 pixel)
|
||||
*\param interp interpolation algorithm
|
||||
*\param full \a 1 (default value) means that the retinal image (the inverse transform) is computed within the circumscribing circle.
|
||||
* \a 0 means that the retinal image is computed within the inscribed circle.
|
||||
*\param S the number of sectors of the cortical image (default value 70 pixel).
|
||||
|
@@ -88,7 +88,7 @@ enum RETINA_COLORSAMPLINGMETHOD
|
||||
class RetinaFilter;
|
||||
|
||||
/**
|
||||
* @class Retina a wrapper class which allows the Gipsa/Listic Labs model to be used.
|
||||
* a wrapper class which allows the Gipsa/Listic Labs model to be used.
|
||||
* This retina model allows spatio-temporal image processing (applied on still images, video sequences).
|
||||
* As a summary, these are the retina model properties:
|
||||
* => It applies a spectral whithening (mid-frequency details enhancement)
|
||||
@@ -199,7 +199,6 @@ public:
|
||||
* => if the xml file does not exist, then default setup is applied
|
||||
* => warning, Exceptions are thrown if read XML file is not valid
|
||||
* @param newParameters : a parameters structures updated with the new target configuration
|
||||
* @param applyDefaultSetupOnFailure : set to true if an error must be thrown on error
|
||||
*/
|
||||
void setup(RetinaParameters newParameters);
|
||||
|
||||
@@ -216,7 +215,7 @@ public:
|
||||
|
||||
/**
|
||||
* write xml/yml formated parameters information
|
||||
* @rparam fs : the filename of the xml file that will be open and writen with formatted parameters information
|
||||
* @param fs : the filename of the xml file that will be open and writen with formatted parameters information
|
||||
*/
|
||||
virtual void write( std::string fs ) const;
|
||||
|
||||
|
Reference in New Issue
Block a user