doc/check_docs_whitelist.txt

   1 # this is a list of functions, classes and methods
   2 # that are not supposed to be documented in the near future,
   3 # to make the output of check_docs.py script more sensible.
   4 #
   5 # Syntax:
   6 #    every line starting with # is a comment
   7 #    there can be empty lines
   8 #    each line includes either a class name (including all the necessary namespaces),
   9 #                              or a function/method name
  10 #                              or a full declaration of a function/method
  11 #    if a class name is in the whitelist, all the methods are considered "white-listed" too
  12 #    if a method/function name is listed, then all the overload variants are "white-listed".
  13 #    that is, to white list a particular overloaded variant of a function/method you need to put
  14 #    full declaration into the file
  15 #
  16
  17 ######################################### core #####################################
  18 cv::Mat::MSize
  19 cv::Mat::MStep
  20 cv::MatConstIterator
  21 cv::NAryMatIterator
  22 cv::Algorithm
  23 cv::_InputArray
  24 cv::_OutputArray
  25
  26 ######################################## imgproc ###################################
  27 CvLSHOperations
  28 cv::FilterEngine
  29 cv::BaseFilter
  30 cv::BaseRowFilter
  31 cv::BaseColumnFilter
  32 cv::Moments
  33
  34 ###################################### features2d###################################
  35 cv::BOWKMeansTrainer::cluster
  36 cv::BOWTrainer::BOWTrainer
  37 cv::BOWTrainer::clear
  38 cv::AdjusterAdapter::clone
  39
  40 cv::MSER::MSER
  41 cv::StarDetector::StarDetector
  42 cv::SIFT::CommonParams::CommonParams
  43 cv::SIFT::SIFT
  44 cv::SURF::SURF
  45 cv::SimpleBlobDetector::Params::Params
  46
  47 cv::FastFeatureDetector::read
  48 cv::MserFeatureDetector::read
  49 cv::StarFeatureDetector::read
  50 cv::SurfFeatureDetector::read
  51 cv::SiftFeatureDetector::read
  52 cv::GoodFeaturesToTrackDetector::read
  53 cv::OrbFeatureDetector::read
  54
  55 cv::FastFeatureDetector::write
  56 cv::MserFeatureDetector::write
  57 cv::StarFeatureDetector::write
  58 cv::SurfFeatureDetector::write
  59 cv::SiftFeatureDetector::write
  60 cv::GoodFeaturesToTrackDetector::write
  61 cv::OrbFeatureDetector::write
  62
  63 cv::DynamicAdaptedFeatureDetector::empty
  64 cv::GridAdaptedFeatureDetector::empty
  65 cv::PyramidAdaptedFeatureDetector::empty
  66
  67 cv::BriefDescriptorExtractor::descriptorSize
  68 cv::SurfDescriptorExtractor::descriptorSize
  69 cv::SiftDescriptorExtractor::descriptorSize
  70 cv::OpponentColorDescriptorExtractor::descriptorSize
  71 cv::OrbDescriptorExtractor::descriptorSize
  72
  73 cv::BriefDescriptorExtractor::descriptorType
  74 cv::SurfDescriptorExtractor::descriptorType
  75 cv::SiftDescriptorExtractor::descriptorType
  76 cv::OpponentColorDescriptorExtractor::descriptorType
  77 cv::OrbDescriptorExtractor::descriptorType
  78
  79 cv::SurfDescriptorExtractor::read
  80 cv::SiftDescriptorExtractor::read
  81 cv::OpponentColorDescriptorExtractor::read
  82 cv::OrbDescriptorExtractor::read
  83
  84 cv::SurfDescriptorExtractor::write
  85 cv::SiftDescriptorExtractor::write
  86 cv::OpponentColorDescriptorExtractor::write
  87 cv::OrbDescriptorExtractor::write
  88
  89 cv::OpponentColorDescriptorExtractor::empty
  90
  91 cv::FlannBasedMatcher::train
  92
  93 cv::FlannBasedMatcher::clear
  94
  95 cv::FlannBasedMatcher::clone
  96
  97 cv::FlannBasedMatcher::isMaskSupported
  98
  99
 100 cv::GenericDescriptorMatcher::GenericDescriptorMatcher
 101
 102 cv::VectorDescriptorMatcher::clear
 103 cv::FernDescriptorMatcher::clear
 104 cv::OneWayDescriptorMatcher::clear
 105
 106 cv::VectorDescriptorMatcher::empty
 107 cv::FernDescriptorMatcher::empty
 108 cv::OneWayDescriptorMatcher::empty
 109
 110 cv::OneWayDescriptorMatcher::read
 111
 112 cv::VectorDescriptorMatcher::isMaskSupported
 113 cv::FernDescriptorMatcher::isMaskSupported
 114 cv::OneWayDescriptorMatcher::isMaskSupported
 115
 116 cv::VectorDescriptorMatcher::train
 117 cv::FernDescriptorMatcher::train
 118 cv::OneWayDescriptorMatcher::train
 119
 120 cv::VectorDescriptorMatcher::read
 121 cv::FernDescriptorMatcher::read
 122
 123 cv::VectorDescriptorMatcher::write
 124 cv::FernDescriptorMatcher::write
 125 cv::OneWayDescriptorMatcher::write
 126
 127
 128
 129 cv::FastAdjuster::good
 130 cv::StarAdjuster::good
 131 cv::SurfAdjuster::good
 132 cv::FastAdjuster::tooFew
 133 cv::StarAdjuster::tooFew
 134 cv::SurfAdjuster::tooFew
 135 cv::FastAdjuster::tooMany
 136 cv::StarAdjuster::tooMany
 137 cv::SurfAdjuster::tooMany
 138 cv::FastAdjuster::clone
 139 cv::StarAdjuster::clone
 140 cv::SurfAdjuster::clone
 141
 142 ######################################## calib3d ###################################
 143 CvLevMarq
 144 Mat cv::findFundamentalMat( InputArray points1, InputArray points2, OutputArray mask, int method=FM_RANSAC, double param1=3., double param2=0.99)
 145 Mat findHomography( InputArray srcPoints, InputArray dstPoints, OutputArray mask, int method=0, double ransacReprojThreshold=3);
 146
 147 ########################################## ml ######################################
 148 CvBoostTree
 149 CvForestTree
 150 CvSVMKernel
 151 CvSVMSolver
 152 CvDTreeTrainData
 153 CvERTreeTrainData
 154 CvKNearest::CvKNearest
 155 CvKNearest::clear
 156 CvDTreeNode::get_num_valid
 157 CvDTreeNode::set_num_valid
 158 CvDTree::CvDTree
 159 CvDTree::clear
 160 CvDTree::read
 161 CvDTree::write
 162 CvEM::CvEM
 163 CvEM::clear
 164 CvEM::read
 165 CvEM::write
 166 CvSVM::CvSVM
 167 CvSVM::clear
 168 CvSVM::read
 169 CvSVM::write
 170 CvMLData::CvMLData
 171 CvRTrees::CvRTrees
 172 CvRTrees::clear
 173 CvRTrees::read
 174 CvRTrees::write
 175 CvBoost::CvBoost
 176 CvBoost::clear
 177 CvBoost::read
 178 CvBoost::write
 179 CvGBTrees::CvGBTrees
 180 CvGBTrees::clear
 181 CvGBTrees::read
 182 CvGBTrees::write
 183 CvNormalBayesClassifier::CvNormalBayerClassifier
 184 CvNormalBayesClassifier::clear
 185 CvNormalBayesClassifier::read
 186 CvNormalBayesClassifier::write
 187 CvANN_MLP::CvANN_MLP
 188 CvANN_MLP::clear
 189 CvANN_MLP::read
 190 CvANN_MLP::write
 191 CvTrainTestSplit
 192 cvParamLattice
 193 cvDefaultParamLattice