update docs for TessBaseAPI::SetProbabilityInContextFunc based on Ray…

…'s email today
lsfjGitHub · Sep 9, 2014 · c0c7193 · c0c7193
1 parent 541e06c
commit c0c7193
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/api/baseapi.cpp b/api/baseapi.cpp
@@ -1940,6 +1940,10 @@ void TessBaseAPI::SetDictFunc(DictFunc f) {
 /**
  * Sets Dict::probability_in_context_ function to point to the given
  * function.
+ *
+ * @param f A single function that returns the probability of the current 
+ * "character" (in general a utf-8 string), given the context of a previous 
+ * utf-8 string.
  */
 void TessBaseAPI::SetProbabilityInContextFunc(ProbabilityInContextFunc f) {
   if (tesseract_ != NULL) {