From 0267dec052810d2ed13d32244bd048c846b42b2d Mon Sep 17 00:00:00 2001 From: Jim O'Regan Date: Mon, 20 Jul 2015 15:57:17 +0100 Subject: [PATCH] doxygen classify/cutoffs.cpp --- classify/cutoffs.cpp | 35 +++++++++++++++-------------------- 1 file changed, 15 insertions(+), 20 deletions(-) diff --git a/classify/cutoffs.cpp b/classify/cutoffs.cpp index 67a240d8..bf21fb1b 100644 --- a/classify/cutoffs.cpp +++ b/classify/cutoffs.cpp @@ -15,9 +15,9 @@ ** See the License for the specific language governing permissions and ** limitations under the License. ******************************************************************************/ -/**---------------------------------------------------------------------------- +/*---------------------------------------------------------------------------- Include Files and Type Defines -----------------------------------------------------------------------------**/ +----------------------------------------------------------------------------*/ #include "cutoffs.h" #include @@ -34,26 +34,21 @@ #define MAX_CUTOFF 1000 -/**---------------------------------------------------------------------------- - Public Code -----------------------------------------------------------------------------**/ -/*---------------------------------------------------------------------------*/ namespace tesseract { +/** + * Open Filename, read in all of the class-id/cutoff pairs + * and insert them into the Cutoffs array. Cutoffs are + * indexed in the array by class id. Unused entries in the + * array are set to an arbitrarily high cutoff value. + * @param Filename name of file containing cutoff definitions + * @param Cutoffs array to put cutoffs into + * @return none + * @note Globals: none + * @note Exceptions: none + * @note History: Wed Feb 20 09:38:26 1991, DSJ, Created. + */ void Classify::ReadNewCutoffs(FILE *CutoffFile, bool swap, inT64 end_offset, CLASS_CUTOFF_ARRAY Cutoffs) { -/* - ** Parameters: - ** Filename name of file containing cutoff definitions - ** Cutoffs array to put cutoffs into - ** Globals: none - ** Operation: Open Filename, read in all of the class-id/cutoff pairs - ** and insert them into the Cutoffs array. Cutoffs are - ** indexed in the array by class id. Unused entries in the - ** array are set to an arbitrarily high cutoff value. - ** Return: none - ** Exceptions: none - ** History: Wed Feb 20 09:38:26 1991, DSJ, Created. - */ char Class[UNICHAR_LEN + 1]; CLASS_ID ClassId; int Cutoff; @@ -78,6 +73,6 @@ void Classify::ReadNewCutoffs(FILE *CutoffFile, bool swap, inT64 end_offset, Cutoffs[ClassId] = Cutoff; SkipNewline(CutoffFile); } -} /* ReadNewCutoffs */ +} } // namespace tesseract