From 8bca324848ee9ce087c61387f0d7abebe4035df9 Mon Sep 17 00:00:00 2001 From: Jim O'Regan Date: Mon, 20 Jul 2015 12:43:47 +0100 Subject: [PATCH] doxygen classify/normfeat.cpp --- classify/normfeat.cpp | 60 +++++++++++++++++++++---------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/classify/normfeat.cpp b/classify/normfeat.cpp index 7f383cb8..a4ac672a 100644 --- a/classify/normfeat.cpp +++ b/classify/normfeat.cpp @@ -15,50 +15,50 @@ ** See the License for the specific language governing permissions and ** limitations under the License. ******************************************************************************/ -/**---------------------------------------------------------------------------- +/*---------------------------------------------------------------------------- Include Files and Type Defines -----------------------------------------------------------------------------**/ +----------------------------------------------------------------------------*/ #include "normfeat.h" #include "intfx.h" #include "featdefs.h" #include "mfoutline.h" -/**---------------------------------------------------------------------------- +/*---------------------------------------------------------------------------- Public Code -----------------------------------------------------------------------------**/ +----------------------------------------------------------------------------*/ -// Return the length of the outline in baseline normalized form. +/** Return the length of the outline in baseline normalized form. */ FLOAT32 ActualOutlineLength(FEATURE Feature) { return (Feature->Params[CharNormLength] * LENGTH_COMPRESSION); } -/*---------------------------------------------------------------------------*/ -// Return the character normalization feature for a blob. -// -// The features returned are in a scale where the x-height has been -// normalized to live in the region y = [-0.25 .. 0.25]. Example ranges -// for English below are based on the Linux font collection on 2009-12-04: -// -// Params[CharNormY] -// The y coordinate of the grapheme's centroid. -// English: [-0.27, 0.71] -// -// Params[CharNormLength] -// The length of the grapheme's outline (tiny segments discarded), -// divided by 10.0=LENGTH_COMPRESSION. -// English: [0.16, 0.85] -// -// Params[CharNormRx] -// The radius of gyration about the x axis, as measured from CharNormY. -// English: [0.011, 0.34] -// -// Params[CharNormRy] -// The radius of gyration about the y axis, as measured from -// the x center of the grapheme's bounding box. -// English: [0.011, 0.31] -// +/** + * Return the character normalization feature for a blob. + * + * The features returned are in a scale where the x-height has been + * normalized to live in the region y = [-0.25 .. 0.25]. Example ranges + * for English below are based on the Linux font collection on 2009-12-04: + * + * - Params[CharNormY] + * - The y coordinate of the grapheme's centroid. + * - English: [-0.27, 0.71] + * + * - Params[CharNormLength] + * - The length of the grapheme's outline (tiny segments discarded), + * divided by 10.0=LENGTH_COMPRESSION. + * - English: [0.16, 0.85] + * + * - Params[CharNormRx] + * - The radius of gyration about the x axis, as measured from CharNormY. + * - English: [0.011, 0.34] + * + * - Params[CharNormRy] + * - The radius of gyration about the y axis, as measured from + * the x center of the grapheme's bounding box. + * - English: [0.011, 0.31] + */ FEATURE_SET ExtractCharNormFeatures(const INT_FX_RESULT_STRUCT& fx_info) { FEATURE_SET feature_set = NewFeatureSet(1); FEATURE feature = NewFeature(&CharNormDesc);