Browse Source

Further simplification of comments above enums (ref. Issue #178)

pull/407/head
Dan Bloomberg 6 years ago
parent
commit
11ad2139a5
  1. 6
      src/array.h
  2. 2
      src/bmf.h
  3. 2
      src/ccbord.h
  4. 10
      src/imageio.h
  5. 4
      src/jbclass.h
  6. 26
      src/morph.h
  7. 110
      src/pix.h
  8. 6
      src/ptra.h
  9. 2
      src/rbtree.h
  10. 4
      src/readbarcode.h
  11. 4
      src/recog.h
  12. 2
      src/regutils.h
  13. 2
      src/stringcode.h
  14. 2
      src/sudoku.h

6
src/array.h

@ -136,20 +136,20 @@ typedef struct L_Bytea L_BYTEA;
/*------------------------------------------------------------------------*
* Array flags *
*------------------------------------------------------------------------*/
/*! Numa Interpolation Flags */
/*! Numa Interpolation */
enum {
L_LINEAR_INTERP = 1, /*!< linear */
L_QUADRATIC_INTERP = 2 /*!< quadratic */
};
/*! Border Adding Flags */
/*! Border Adding */
enum {
L_CONTINUED_BORDER = 1, /*!< extended with same value */
L_SLOPE_BORDER = 2, /*!< extended with constant normal derivative */
L_MIRRORED_BORDER = 3 /*!< mirrored */
};
/*! Numa Data Conversion Flags */
/*! Numa Data Conversion */
enum {
L_INTEGER_VALUE = 1, /*!< convert to integer */
L_FLOAT_VALUE = 2 /*!< convert to float */

2
src/bmf.h

@ -34,7 +34,7 @@
*/
/*! Constants for deciding when text block is divided into paragraphs */
/*! Text Split Flags */
/*! Split Text */
enum {
SPLIT_ON_LEADING_WHITE = 1, /*!< tab or space at beginning of line */
SPLIT_ON_BLANK_LINE = 2, /*!< newline with optional white space */

2
src/ccbord.h

@ -37,12 +37,14 @@
*/
/*! Use in ccbaStepChainsToPixCoords() */
/*! CCB Coords */
enum {
CCB_LOCAL_COORDS = 1,
CCB_GLOBAL_COORDS = 2
};
/*! Use in ccbaGenerateSPGlobalLocs() */
/*! CCB Points */
enum {
CCB_SAVE_ALL_PTS = 1,
CCB_SAVE_TURNING_PTS = 2

10
src/imageio.h

@ -87,7 +87,7 @@
* file formats before IFF_DEFAULT will remain invariant.
*/
/*! Image Format Types */
/*! Image Formats */
enum {
IFF_UNKNOWN = 0,
IFF_BMP = 1,
@ -116,7 +116,7 @@ enum {
* Format header ids *
* --------------------------------------------------------------- */
/*! Format Header Ids */
/*! Header Ids */
enum {
BMP_ID = 0x4d42, /*!< BM - for bitmaps */
TIFF_BIGEND_ID = 0x4d4d, /*!< MM - for 'motorola' */
@ -128,7 +128,7 @@ enum {
* Hinting bit flags in jpeg reader *
* --------------------------------------------------------------- */
/*! Jpeg Hint Flags */
/*! Jpeg Hints */
enum {
L_JPEG_READ_LUMINANCE = 1, /*!< only want luminance data; no chroma */
L_JPEG_FAIL_ON_BAD_DATA = 2 /*!< don't return possibly damaged pix */
@ -139,7 +139,7 @@ enum {
* Pdf formatted encoding types *
* --------------------------------------------------------------- */
/*! Pdf Encoding Types */
/*! Pdf Encoding */
enum {
L_DEFAULT_ENCODE = 0, /*!< use default encoding based on image */
L_JPEG_ENCODE = 1, /*!< use dct encoding: 8 and 32 bpp, no cmap */
@ -190,7 +190,7 @@ typedef struct L_Compressed_Data L_COMP_DATA;
* Pdf multi image flags *
* ------------------------------------------------------------------------- */
/*! Pdf Multi Image Flags */
/*! Pdf MultiImage */
enum {
L_FIRST_IMAGE = 1, /*!< first image to be used */
L_NEXT_IMAGE = 2, /*!< intermediate image; not first or last */

4
src/jbclass.h

@ -119,14 +119,14 @@ struct JbData
typedef struct JbData JBDATA;
/*! JB Classifier Type */
/*! JB Classifier */
enum {
JB_RANKHAUS = 0,
JB_CORRELATION = 1
};
/*! For jbGetComponents(): type of component to extract from images */
/*! JB Component Type */
/*! JB Component */
enum {
JB_CONN_COMPS = 0,
JB_CHARACTERS = 1,

26
src/morph.h

@ -105,17 +105,17 @@ typedef struct L_Kernel L_KERNEL;
* See notes in morph.c for usage. *
*-------------------------------------------------------------------------*/
/*! Morph Boundary Flags */
/*! Morph Boundary */
enum {
SYMMETRIC_MORPH_BC = 0,
ASYMMETRIC_MORPH_BC = 1
};
/*-------------------------------------------------------------------------*
* Structuring element types *
* Structuring element vals *
*-------------------------------------------------------------------------*/
/*! Struct Element Types */
/*! SEL Vals */
enum {
SEL_DONT_CARE = 0,
SEL_HIT = 1,
@ -126,7 +126,7 @@ enum {
* Runlength flags for granulometry *
*-------------------------------------------------------------------------*/
/*! Runlength Polarity Flags */
/*! Runlength Polarity */
enum {
L_RUN_OFF = 0,
L_RUN_ON = 1
@ -148,7 +148,7 @@ enum {
* Morphological operation flags *
*-------------------------------------------------------------------------*/
/*! Morph Type */
/*! Morph Operator */
enum {
L_MORPH_DILATE = 1,
L_MORPH_ERODE = 2,
@ -161,7 +161,7 @@ enum {
* Grayscale intensity scaling flags *
*-------------------------------------------------------------------------*/
/*! Pixel Value Scaling Flags */
/*! Pixel Value Scaling */
enum {
L_LINEAR_SCALE = 1,
L_LOG_SCALE = 2
@ -171,7 +171,7 @@ enum {
* Morphological tophat flags *
*-------------------------------------------------------------------------*/
/*! Morph Tophat Flags */
/*! Morph Tophat */
enum {
L_TOPHAT_WHITE = 0,
L_TOPHAT_BLACK = 1
@ -182,7 +182,7 @@ enum {
* (use on grayscale images and Numas) *
*-------------------------------------------------------------------------*/
/*! Arith_and_logical Flags */
/*! ArithLogical Ops */
enum {
L_ARITH_ADD = 1,
L_ARITH_SUBTRACT = 2,
@ -198,7 +198,7 @@ enum {
* Min/max selection flags *
*-------------------------------------------------------------------------*/
/*! Min_max Selection Flags */
/*! MinMax Selection */
enum {
L_CHOOSE_MIN = 1, /* useful in a downscaling "erosion" */
L_CHOOSE_MAX = 2, /* useful in a downscaling "dilation" */
@ -208,10 +208,10 @@ enum {
};
/*-------------------------------------------------------------------------*
* Distance function b.c. flags *
* Exterior value b.c. for distance function flags *
*-------------------------------------------------------------------------*/
/*! Distance BC Flags */
/*! Exterior Value */
enum {
L_BOUNDARY_BG = 1, /* assume bg outside image */
L_BOUNDARY_FG = 2 /* assume fg outside image */
@ -221,7 +221,7 @@ enum {
* Image comparison flags *
*-------------------------------------------------------------------------*/
/*! Image Comparison Flags */
/*! Image Comparison */
enum {
L_COMPARE_XOR = 1,
L_COMPARE_SUBTRACT = 2,
@ -232,7 +232,7 @@ enum {
* Color content flags *
*-------------------------------------------------------------------------*/
/*! Color Content Flags */
/*! Color Content */
enum {
L_MAX_DIFF_FROM_AVERAGE_2 = 1,
L_MAX_MIN_DIFF_FROM_2 = 2,

110
src/pix.h

@ -197,7 +197,7 @@ typedef struct RGBA_Quad RGBA_QUAD;
* </pre>
*/
/*! RGBA Color Flags */
/*! RGBA Color */
enum {
COLOR_RED = 0, /*!< red color index in RGBA_QUAD */
COLOR_GREEN = 1, /*!< green color index in RGBA_QUAD */
@ -218,7 +218,7 @@ static const l_int32 L_ALPHA_SHIFT =
/*-------------------------------------------------------------------------*
* Colors for drawing boxes *
*-------------------------------------------------------------------------*/
/*! Box Color Flags */
/*! Box Color */
enum {
L_DRAW_RED = 0, /*!< draw in red */
L_DRAW_GREEN = 1, /*!< draw in green */
@ -249,7 +249,7 @@ static const l_float32 L_BLUE_WEIGHT = 0.2f; /*!< Percept. weight for blue */
/*-------------------------------------------------------------------------*
* Flags for colormap conversion *
*-------------------------------------------------------------------------*/
/*! Cmap Conversion Flags */
/*! Cmap Conversion */
enum {
REMOVE_CMAP_TO_BINARY = 0, /*!< remove colormap for conv to 1 bpp */
REMOVE_CMAP_TO_GRAYSCALE = 1, /*!< remove colormap for conv to 8 bpp */
@ -712,7 +712,7 @@ typedef struct PixaComp PIXAC;
* </pre>
*/
/*! Access Flags */
/*! Object Access */
enum {
L_NOCOPY = 0, /*!< do not copy the object; do not delete the ptr */
L_INSERT = L_NOCOPY, /*!< stuff it in; do not copy or clone */
@ -726,19 +726,19 @@ enum {
/*----------------------------------------------------------------------------*
* Sort flags *
*----------------------------------------------------------------------------*/
/*! Sort Mode Flags */
/*! Sort Mode */
enum {
L_SHELL_SORT = 1, /*!< use shell sort */
L_BIN_SORT = 2 /*!< use bin sort */
};
/*! Sort Order Flags */
/*! Sort Order */
enum {
L_SORT_INCREASING = 1, /*!< sort in increasing order */
L_SORT_DECREASING = 2 /*!< sort in decreasing order */
};
/*! Sort Type Flags */
/*! Sort Type */
enum {
L_SORT_BY_X = 1, /*!< sort box or c.c. by left edge location */
L_SORT_BY_Y = 2, /*!< sort box or c.c. by top edge location */
@ -757,7 +757,7 @@ enum {
/*---------------------------------------------------------------------------*
* Blend flags *
*---------------------------------------------------------------------------*/
/*! Blend Flags */
/*! Blend Types */
enum {
L_BLEND_WITH_INVERSE = 1, /*!< add some of src inverse to itself */
L_BLEND_TO_WHITE = 2, /*!< shift src colors towards white */
@ -767,7 +767,7 @@ enum {
/*!< based on blender pix value */
};
/*! Paint Flags */
/*! Paint Selection */
enum {
L_PAINT_LIGHT = 1, /*!< colorize non-black pixels */
L_PAINT_DARK = 2 /*!< colorize non-white pixels */
@ -777,7 +777,7 @@ enum {
/*-------------------------------------------------------------------------*
* Graphics pixel setting *
*-------------------------------------------------------------------------*/
/*! Pixel Setting Flags */
/*! Pixel Setting */
enum {
L_SET_PIXELS = 1, /*!< set all bits in each pixel to 1 */
L_CLEAR_PIXELS = 2, /*!< set all bits in each pixel to 0 */
@ -788,7 +788,7 @@ enum {
/*-------------------------------------------------------------------------*
* Size and location filter flags *
*-------------------------------------------------------------------------*/
/*! Size Comparison Flags */
/*! Size Comparison */
enum {
L_SELECT_IF_LT = 1, /*!< save if value is less than threshold */
L_SELECT_IF_GT = 2, /*!< save if value is more than threshold */
@ -796,7 +796,7 @@ enum {
L_SELECT_IF_GTE = 4 /*!< save if value is >= to the threshold */
};
/*! Size Selection Flags */
/*! Size Selection */
enum {
L_SELECT_BY_WIDTH = 1, /*!< select by width; 1 bpp */
L_SELECT_BY_HEIGHT = 2, /*!< select by height; 1 bpp */
@ -806,7 +806,7 @@ enum {
L_SELECT_BY_PERIMETER = 5 /*!< select by perimeter; 1 bpp */
};
/*! Location filter flags */
/*! Location Filter */
enum {
L_SELECT_WIDTH = 1, /*!< width must satisfy constraint */
L_SELECT_HEIGHT = 2, /*!< height must satisfy constraint */
@ -818,7 +818,7 @@ enum {
/*!< and yval must satisfy constraint */
};
/*! Boxa Check Flags */
/*! Boxa Check */
enum {
L_CHECK_WIDTH = 1, /*!< check and possibly modify width */
L_CHECK_HEIGHT = 2, /*!< check and possibly modify height */
@ -829,7 +829,7 @@ enum {
/*-------------------------------------------------------------------------*
* Color component selection flags *
*-------------------------------------------------------------------------*/
/*! Color Selection Flags */
/*! Color Selection */
enum {
L_SELECT_RED = 1, /*!< use red component */
L_SELECT_GREEN = 2, /*!< use green component */
@ -845,7 +845,7 @@ enum {
/*-------------------------------------------------------------------------*
* 16-bit conversion flags *
*-------------------------------------------------------------------------*/
/*! 16-bit Conversion Flags */
/*! 16-bit Conversion */
enum {
L_LS_BYTE = 1, /*!< use LSB */
L_MS_BYTE = 2, /*!< use MSB */
@ -860,20 +860,20 @@ enum {
/*-------------------------------------------------------------------------*
* Rotate and shear flags *
*-------------------------------------------------------------------------*/
/*! Rotate Flags */
/*! Rotation Type */
enum {
L_ROTATE_AREA_MAP = 1, /*!< use area map rotation, if possible */
L_ROTATE_SHEAR = 2, /*!< use shear rotation */
L_ROTATE_SAMPLING = 3 /*!< use sampling */
};
/*! Background Color Flags */
/*! Background Color */
enum {
L_BRING_IN_WHITE = 1, /*!< bring in white pixels from the outside */
L_BRING_IN_BLACK = 2 /*!< bring in black pixels from the outside */
};
/*! Shear Flags */
/*! Shear Point */
enum {
L_SHEAR_ABOUT_CORNER = 1, /*!< shear image about UL corner */
L_SHEAR_ABOUT_CENTER = 2 /*!< shear image about center */
@ -883,7 +883,7 @@ enum {
/*-------------------------------------------------------------------------*
* Affine transform order flags *
*-------------------------------------------------------------------------*/
/*! Affine Transform Flags */
/*! Affine Transform Order */
enum {
L_TR_SC_RO = 1, /*!< translate, scale, rotate */
L_SC_RO_TR = 2, /*!< scale, rotate, translate */
@ -897,7 +897,7 @@ enum {
/*-------------------------------------------------------------------------*
* Grayscale filling flags *
*-------------------------------------------------------------------------*/
/*! Grayscale Fill Flags */
/*! Grayscale Fill */
enum {
L_FILL_WHITE = 1, /*!< fill white pixels (e.g, in fg map) */
L_FILL_BLACK = 2 /*!< fill black pixels (e.g., in bg map) */
@ -907,7 +907,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for setting to white or black *
*-------------------------------------------------------------------------*/
/*! BlackWhite Set Flags */
/*! BlackWhite Set */
enum {
L_SET_WHITE = 1, /*!< set pixels to white */
L_SET_BLACK = 2 /*!< set pixels to black */
@ -917,7 +917,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for getting white or black value *
*-------------------------------------------------------------------------*/
/*! BlackWhite Get Flags */
/*! BlackWhite Get */
enum {
L_GET_WHITE_VAL = 1, /*!< get white pixel value */
L_GET_BLACK_VAL = 2 /*!< get black pixel value */
@ -927,7 +927,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for 8 bit and 16 bit pixel sums *
*-------------------------------------------------------------------------*/
/*! BlackWhite Sum Flags */
/*! BlackWhite Sum */
enum {
L_WHITE_IS_MAX = 1, /*!< white pixels are 0xff or 0xffff; black are 0 */
L_BLACK_IS_MAX = 2 /*!< black pixels are 0xff or 0xffff; white are 0 */
@ -939,7 +939,7 @@ enum {
* If within this grayscale distance from black or white, *
* do not propagate excess or deficit to neighboring pixels. *
*-------------------------------------------------------------------------*/
/*! Dither Flags */
/*! Dither Distance */
enum {
DEFAULT_CLIP_LOWER_1 = 10, /*!< dist to black with no prop; 1 bpp */
DEFAULT_CLIP_UPPER_1 = 10, /*!< dist to black with no prop; 1 bpp */
@ -951,7 +951,7 @@ enum {
/*-------------------------------------------------------------------------*
* Distance type flags *
*-------------------------------------------------------------------------*/
/*! Distance Type Flags */
/*! Distance Type */
enum {
L_MANHATTAN_DISTANCE = 1, /*!< L1 distance (e.g., in color space) */
L_EUCLIDEAN_DISTANCE = 2 /*!< L2 distance */
@ -961,7 +961,7 @@ enum {
/*-------------------------------------------------------------------------*
* Distance Value flags *
*-------------------------------------------------------------------------*/
/*! Distance Value Flags */
/*! Distance Value */
enum {
L_NEGATIVE = 1, /*!< values < 0 */
L_NON_NEGATIVE = 2, /*!< values >= 0 */
@ -975,7 +975,7 @@ enum {
/*-------------------------------------------------------------------------*
* Statistical measures *
*-------------------------------------------------------------------------*/
/*! Stats Measure Flags */
/*! Stats Type */
enum {
L_MEAN_ABSVAL = 1, /*!< average of abs values */
L_MEDIAN_VAL = 2, /*!< median value of set */
@ -990,7 +990,7 @@ enum {
/*-------------------------------------------------------------------------*
* Set index selection flags *
*-------------------------------------------------------------------------*/
/*! Index Selection Flags */
/*! Index Selection */
enum {
L_CHOOSE_CONSECUTIVE = 1, /*!< select 'n' consecutive */
L_CHOOSE_SKIP_BY = 2 /*!< select at intervals of 'n' */
@ -1000,7 +1000,7 @@ enum {
/*-------------------------------------------------------------------------*
* Text orientation flags *
*-------------------------------------------------------------------------*/
/*! Text Orientation Flags */
/*! Text Orientation */
enum {
L_TEXT_ORIENT_UNKNOWN = 0, /*!< low confidence on text orientation */
L_TEXT_ORIENT_UP = 1, /*!< portrait, text rightside-up */
@ -1013,7 +1013,7 @@ enum {
/*-------------------------------------------------------------------------*
* Edge orientation flags *
*-------------------------------------------------------------------------*/
/*! Edge Orientation Flags */
/*! Edge Orientation */
enum {
L_HORIZONTAL_EDGES = 0, /*!< filters for horizontal edges */
L_VERTICAL_EDGES = 1, /*!< filters for vertical edges */
@ -1024,7 +1024,7 @@ enum {
/*-------------------------------------------------------------------------*
* Line orientation flags *
*-------------------------------------------------------------------------*/
/*! Line Orientation Flags */
/*! Line Orientation */
enum {
L_HORIZONTAL_LINE = 0, /*!< horizontal line */
L_POS_SLOPE_LINE = 1, /*!< 45 degree line with positive slope */
@ -1037,7 +1037,7 @@ enum {
/*-------------------------------------------------------------------------*
* Image orientation flags *
*-------------------------------------------------------------------------*/
/*! Image Orientation Flags */
/*! Image Orientation */
enum {
L_PORTRAIT_MODE = 0, /*!< typical: page is viewed with height > width */
L_LANDSCAPE_MODE = 1 /*!< page is viewed at 90 deg to portrait mode */
@ -1047,7 +1047,7 @@ enum {
/*-------------------------------------------------------------------------*
* Scan direction flags *
*-------------------------------------------------------------------------*/
/*! Scan Direction Flags */
/*! Scan Direction */
enum {
L_FROM_LEFT = 0, /*!< scan from left */
L_FROM_RIGHT = 1, /*!< scan from right */
@ -1064,7 +1064,7 @@ enum {
/*-------------------------------------------------------------------------*
* Box size adjustment and location flags *
*-------------------------------------------------------------------------*/
/*! Box Adjustment Flags */
/*! Box Adjustment */
enum {
L_ADJUST_SKIP = 0, /*!< do not adjust */
L_ADJUST_LEFT = 1, /*!< adjust left edge */
@ -1089,7 +1089,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for modifying box boundaries using a second box *
*-------------------------------------------------------------------------*/
/*! Box Boundary Mod Flags */
/*! Box Boundary Mod */
enum {
L_USE_MINSIZE = 1, /*!< use boundaries giving min size */
L_USE_MAXSIZE = 2, /*!< use boundaries giving max size */
@ -1103,7 +1103,7 @@ enum {
/*-------------------------------------------------------------------------*
* Handling overlapping bounding boxes in boxa *
*-------------------------------------------------------------------------*/
/*! Box Overlap Mod Flags */
/*! Box Overlap Mod */
enum {
L_COMBINE = 1, /*!< resize to bounding region; remove smaller */
L_REMOVE_SMALL = 2 /*!< only remove smaller */
@ -1113,7 +1113,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for replacing invalid boxes *
*-------------------------------------------------------------------------*/
/*! Invalid Box Replacement Flags */
/*! Box Replacement */
enum {
L_USE_ALL_BOXES = 1, /*!< consider all boxes in the sequence */
L_USE_SAME_PARITY_BOXES = 2 /*!< consider boxes with the same parity */
@ -1123,7 +1123,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for box corners *
*-------------------------------------------------------------------------*/
/*! Box CornerFlags */
/*! Box Corners */
enum {
L_UPPER_LEFT = 1, /*!< UL corner */
L_UPPER_RIGHT = 2, /*!< UR corner */
@ -1135,13 +1135,13 @@ enum {
/*-------------------------------------------------------------------------*
* Horizontal warp *
*-------------------------------------------------------------------------*/
/*! Horiz Warp Stretch Flags */
/*! Horiz Warp Stretch */
enum {
L_WARP_TO_LEFT = 1, /*!< increasing stretch or contraction to left */
L_WARP_TO_RIGHT = 2 /*!< increasing stretch or contraction to right */
};
/*! Horiz Warp Mode Flags */
/*! Horiz Warp Mode */
enum {
L_LINEAR_WARP = 1, /*!< stretch or contraction grows linearly */
L_QUADRATIC_WARP = 2 /*!< stretch or contraction grows quadratically */
@ -1151,7 +1151,7 @@ enum {
/*-------------------------------------------------------------------------*
* Pixel selection for resampling *
*-------------------------------------------------------------------------*/
/*! Pixel Selection Flags */
/*! Pixel Selection */
enum {
L_INTERPOLATED = 1, /*!< linear interpolation from src pixels */
L_SAMPLED = 2 /*!< nearest src pixel sampling only */
@ -1161,7 +1161,7 @@ enum {
/*-------------------------------------------------------------------------*
* Thinning flags *
*-------------------------------------------------------------------------*/
/*! Thinning Flags */
/*! Thinning Polarity */
enum {
L_THIN_FG = 1, /*!< thin foreground of 1 bpp image */
L_THIN_BG = 2 /*!< thin background of 1 bpp image */
@ -1171,7 +1171,7 @@ enum {
/*-------------------------------------------------------------------------*
* Runlength flags *
*-------------------------------------------------------------------------*/
/*! Runlength Flags */
/*! Runlength Direction */
enum {
L_HORIZONTAL_RUNS = 0, /*!< determine runlengths of horizontal runs */
L_VERTICAL_RUNS = 1 /*!< determine runlengths of vertical runs */
@ -1181,7 +1181,7 @@ enum {
/*-------------------------------------------------------------------------*
* Edge filter flags *
*-------------------------------------------------------------------------*/
/*! Edge Filter Flags */
/*! Edge Filter */
enum {
L_SOBEL_EDGE = 1, /*!< Sobel edge filter */
L_TWO_SIDED_EDGE = 2 /*!< Two-sided edge filter */
@ -1191,7 +1191,7 @@ enum {
/*-------------------------------------------------------------------------*
* Subpixel color component ordering in LCD display *
*-------------------------------------------------------------------------*/
/*! Subpixel Color Order Flags */
/*! Subpixel Color Order */
enum {
L_SUBPIXEL_ORDER_RGB = 1, /*!< sensor order left-to-right RGB */
L_SUBPIXEL_ORDER_BGR = 2, /*!< sensor order left-to-right BGR */
@ -1203,7 +1203,7 @@ enum {
/*-------------------------------------------------------------------------*
* HSV histogram flags *
*-------------------------------------------------------------------------*/
/*! HSV Histogram Flags */
/*! HSV Histogram */
enum {
L_HS_HISTO = 1, /*!< Use hue-saturation histogram */
L_HV_HISTO = 2, /*!< Use hue-value histogram */
@ -1214,7 +1214,7 @@ enum {
/*-------------------------------------------------------------------------*
* HSV Region flags (inclusion, exclusion) *
*-------------------------------------------------------------------------*/
/*! HSV Region Flags */
/*! HSV Region */
enum {
L_INCLUDE_REGION = 1, /*!< Use pixels with specified HSV region */
L_EXCLUDE_REGION = 2 /*!< Use pixels outside HSV region */
@ -1224,7 +1224,7 @@ enum {
/*-------------------------------------------------------------------------*
* Location flags for adding text to a pix *
*-------------------------------------------------------------------------*/
/*! Add Text Location Flags */
/*! Add Text Location */
enum {
L_ADD_ABOVE = 1, /*!< Add text above the image */
L_ADD_BELOW = 2, /*!< Add text below the image */
@ -1240,7 +1240,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for plotting on a pix *
*-------------------------------------------------------------------------*/
/*! Pix Plot Flags */
/*! Pix Plot */
enum {
L_PLOT_AT_TOP = 1, /*!< Plot horizontally at top */
L_PLOT_AT_MID_HORIZ = 2, /*!< Plot horizontally at middle */
@ -1254,7 +1254,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for making simple masks *
*-------------------------------------------------------------------------*/
/*! Mask Generation Flags */
/*! Mask Generation */
enum {
L_USE_INNER = 1, /*!< Select the interior part */
L_USE_OUTER = 2 /*!< Select the outer part (e.g., a frame) */
@ -1264,7 +1264,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for selecting display program *
*-------------------------------------------------------------------------*/
/*! Display Program Select Flags */
/*! Display Program */
enum {
L_DISPLAY_WITH_XZGV = 1, /*!< Use xzgv with pixDisplay() */
L_DISPLAY_WITH_XLI = 2, /*!< Use xli with pixDisplay() */
@ -1288,7 +1288,7 @@ enum {
/*-------------------------------------------------------------------------*
* Handling negative values in conversion to unsigned int *
*-------------------------------------------------------------------------*/
/*! Negative Value Handling Flags */
/*! Negative Value */
enum {
L_CLIP_TO_ZERO = 1, /*!< Clip negative values to 0 */
L_TAKE_ABSVAL = 2 /*!< Convert to positive using L_ABS() */
@ -1298,7 +1298,7 @@ enum {
/*-------------------------------------------------------------------------*
* Relative to zero flags *
*-------------------------------------------------------------------------*/
/*! Relative To Zero Flags */
/*! Relative To Zero */
enum {
L_LESS_THAN_ZERO = 1, /*!< Choose values less than zero */
L_EQUAL_TO_ZERO = 2, /*!< Choose values equal to zero */
@ -1309,7 +1309,7 @@ enum {
/*-------------------------------------------------------------------------*
* Flags for adding or removing trailing slash from string *
*-------------------------------------------------------------------------*/
/*! Trailing Slash Flags */
/*! Trailing Slash */
enum {
L_ADD_TRAIL_SLASH = 1, /*!< Add trailing slash to string */
L_REMOVE_TRAIL_SLASH = 2 /*!< Remove trailing slash from string */

6
src/ptra.h

@ -72,20 +72,20 @@ typedef struct L_Ptraa L_PTRAA;
* Accessor and modifier flags for L_Ptra and L_Ptraa *
*------------------------------------------------------------------------*/
/*! Ptra Removal Flags */
/*! Ptra Removal */
enum {
L_NO_COMPACTION = 1, /*!< null the pointer only */
L_COMPACTION = 2 /*!< compact the array */
};
/*! Ptra Insertion Flags */
/*! Ptra Insertion */
enum {
L_AUTO_DOWNSHIFT = 0, /*!< choose based on number of holes */
L_MIN_DOWNSHIFT = 1, /*!< downshifts min # of ptrs below insert */
L_FULL_DOWNSHIFT = 2 /*!< downshifts all ptrs below insert */
};
/*! Ptraa Accessor Flags */
/*! Ptraa Accessor */
enum {
L_HANDLE_ONLY = 0, /*!< ptr to L_Ptra; caller can inspect only */
L_REMOVE = 1 /*!< caller owns; destroy or save in L_Ptraa */

2
src/rbtree.h

@ -44,7 +44,7 @@
#define LEPTONICA_RBTREE_H
/*! The three valid key types for red-black trees, maps and sets. */
/*! RBTree Key Type Flags */
/*! RBTree Key Type */
enum {
L_INT_TYPE = 1,
L_UINT_TYPE = 2,

4
src/readbarcode.h

@ -31,7 +31,7 @@
* Flags for method of extracting barcode widths *
* ----------------------------------------------------------------- */
/*! Flags for method of extracting barcode widths */
/*! Barcode Method */
enum {
L_USE_WIDTHS = 1, /*!< use histogram of barcode widths */
L_USE_WINDOWS = 2 /*!< find best window for decoding transitions */
@ -43,7 +43,7 @@ enum {
* the decoding method to use on a barcode. *
* ----------------------------------------------------------------- */
/*! Flags for barcode formats */
/*! Barcode Format */
enum {
L_BF_UNKNOWN = 0, /*!< unknown format */
L_BF_ANY = 1, /*!< try decoding with all known formats */

4
src/recog.h

@ -241,7 +241,7 @@ typedef struct L_Rdid L_RDID;
/*-------------------------------------------------------------------------*
* Flags for describing limited character sets *
*-------------------------------------------------------------------------*/
/*! Character Set Flags */
/*! Character Set */
enum {
L_UNKNOWN = 0, /*!< character set type is not specified */
L_ARABIC_NUMERALS = 1, /*!< 10 digits */
@ -255,7 +255,7 @@ enum {
* Flags for selecting between using average and all templates: *
* recog->templ_use *
*-------------------------------------------------------------------------*/
/*! Template Select Flags */
/*! Template Select */
enum {
L_USE_ALL_TEMPLATES = 0, /*!< use all templates; default */
L_USE_AVERAGE_TEMPLATES = 1 /*!< use average templates; special cases */

2
src/regutils.h

@ -129,7 +129,7 @@ typedef struct L_RegParams L_REGPARAMS;
/*! Running modes for the test */
/*! Regtest Mode Flags */
/*! Regtest Mode */
enum {
L_REG_GENERATE = 0,
L_REG_COMPARE = 1,

2
src/stringcode.h

@ -50,7 +50,7 @@ typedef struct L_StrCode L_STRCODE;
/*! Select string in stringcode for a specific serializable data type */
/*! Stringcode Select Flag */
/*! Stringcode Select */
enum {
L_STR_TYPE = 0, /*!< typedef for the data type */
L_STR_NAME = 1, /*!< name of the data type */

2
src/sudoku.h

@ -66,7 +66,7 @@ typedef struct L_Sudoku L_SUDOKU;
/*! For printing out array data */
/*! Sudoku Output Flag */
/*! Sudoku Output */
enum {
L_SUDOKU_INIT = 0,
L_SUDOKU_STATE = 1

Loading…
Cancel
Save