mirror/tesseract
1
0
Fork 0
mirror of https://github.com/tesseract-ocr/tesseract.git synced 2024-11-23 18:49:08 +08:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

fix doxygen warnings

Browse Source 
git-svn-id: https://tesseract-ocr.googlecode.com/svn/trunk@715 d0cd1f9f-072b-0410-8dd7-cf729c803f20
This commit is contained in:
zdenop@gmail.com 2012-03-30 15:42:06 +00:00
parent 4f0ff358a7
commit 5958f01f5f
13 changed files with 60 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
ccmain/control.cpp
View File

@ -92,7 +92,7 @@ void Tesseract::recog_pseudo_word(PAGE_RES* page_res,
*
* @param block block
* @param row row of word
* @param word word to recognise
* @param word_res word to recognise
*/
BOOL8 Tesseract::recog_interactive(BLOCK* block, ROW* row, WERD_RES* word_res) {
inT16 char_qual;
@ -170,6 +170,7 @@ bool Tesseract::ProcessTargetWord(const TBOX& word_box,
*
* @param page_res page structure
* @param monitor progress monitor
* @param word_config word_config file
* @param target_word_box specifies just to extract a rectangle
* @param dopasses 0 - all, 1 just pass 1, 2 passes 2 and higher
*/

4
ccstruct/polyblk.cpp
View File

@ -138,7 +138,7 @@ inT16 POLY_BLOCK::winding_number(const ICOORD &point) {
}
/// @Returns true if other is inside this.
/// @return true if other is inside this.
bool POLY_BLOCK::contains(POLY_BLOCK *other) {
inT16 count; // winding count
ICOORDELT_IT it = &vertices; // iterator
@ -301,7 +301,7 @@ void POLY_BLOCK::fill(ScrollView* window, ScrollView::Color colour) {
#endif
/// @Returns true if the polygons of other and this overlap.
/// @return true if the polygons of other and this overlap.
bool POLY_BLOCK::overlap(POLY_BLOCK *other) {
inT16 count; // winding count
ICOORDELT_IT it = &vertices; // iterator

2
classify/adaptive.cpp
View File

@ -157,7 +157,7 @@ namespace tesseract {
* Allocates memory for adapted tempates.
* each char in unicharset to the newly created templates
*
* @param PopulateFromUnicharset if true, add an empty class for
* @param InitFromUnicharset if true, add an empty class for
* @return Ptr to new adapted templates.
*
* @note Globals: none

33
classify/adaptmatch.cpp
View File

@ -167,6 +167,7 @@ namespace tesseract {
* @note History: Mon Mar 11 10:00:58 1991, DSJ, Created.
*
* @param Blob blob to be classified
* @param denorm normalization/denormalization parameters
* @param[out] Choices List of choices found by adaptive matcher.
* @param[out] CPResults Array of CPResultStruct of size MAX_NUM_CLASSES is
* filled on return with the choices found by the
@ -742,6 +743,7 @@ void Classify::SettupPass2() {
* config in that class.
*
* @param Blob blob to model new class after
* @param denorm normalization/denormalization parameters
* @param ClassId id of the class to be initialized
* @param FontinfoId font information inferred from pre-trained templates
* @param Class adapted class to be initialized
@ -843,7 +845,6 @@ void Classify::InitAdaptedClass(TBLOB *Blob,
*
* Globals: none
* @param Blob blob to extract features from
* @param LineStats statistics about text row blob is in
* @param[out] IntFeatures array to fill with integer features
* @param[out] FloatFeatures place to return actual floating-pt features
*
@ -910,7 +911,7 @@ int Classify::AdaptableWord(TWERD *Word,
/*---------------------------------------------------------------------------*/
/**
* @param Blob blob to add to templates for ClassId
* @param LineStats statistics about text line blob is in
* @param denorm normalization/denormalization parameters
* @param ClassId class to add blob to
* @param FontinfoId font information from pre-trained templates
* @param Threshold minimum match rating to existing template
@ -1062,7 +1063,7 @@ void Classify::DisplayAdaptedChar(TBLOB* blob, const DENORM& denorm,
/*---------------------------------------------------------------------------*/
/**
* @param Blob blob to add to templates for ClassId
* @param LineStats statistics about text line blob is in
* @param denorm normalization/denormalization parameters
* @param ClassId class to add blob to
* @param FontinfoId font information from pre-trained teamples
* @param Threshold minimum match rating to existing template
@ -1123,9 +1124,10 @@ void Classify::AdaptToPunc(TBLOB *Blob,
*
* @param[out] results results to add new result to
* @param class_id class of new result
* @param shape_id shape index
* @param rating rating of new result
* @param adapted adapted match or not
* @param config config id of new result
* @param config2 config id of 2nd choice result
* @param fontinfo_id font information of the new result
* @param fontinfo_id2 font information of the 2nd choice result
*
@ -1186,7 +1188,9 @@ void Classify::AddNewResult(ADAPT_RESULTS *results,
* - #AllConfigsOn mask that enables all configs
*
* @param Blob blob to be classified
* @param denorm normalization/denormalization parameters
* @param Templates built-in templates to classify against
* @param Classes adapted class templates
* @param Ambiguities array of class id's to match against
* @param[out] Results place to put match results
*
@ -1403,6 +1407,7 @@ double Classify::ComputeCorrectedRating(bool debug, int unichar_id,
* - BaselineCutoffs expected num features for each class
*
* @param Blob blob to be classified
* @param denorm normalization/denormalization parameters
* @param Templates current set of adapted templates
* @param Results place to put match results
*
@ -1462,6 +1467,7 @@ UNICHAR_ID *Classify::BaselineClassifier(TBLOB *Blob,
* are added to Results.
*
* @param Blob blob to be classified
* @param denorm normalization/denormalization parameters
* @param Templates templates to classify unknown against
* @param Results place to put match results
*
@ -1726,6 +1732,7 @@ void Classify::ConvertMatchesToChoices(const DENORM& denorm, const TBOX& box,
/**
*
* @param Blob blob whose classification is being debugged
* @param denorm normalization/denormalization parameters
* @param Results results of match being debugged
*
* Globals: none
@ -1782,6 +1789,7 @@ void Classify::DebugAdaptiveClassifier(TBLOB *Blob,
* of these classifications are merged together into Results.
*
* @param Blob blob to be classified
* @param denorm normalization/denormalization parameters
* @param Results place to put match results
*
* Globals:
@ -1839,6 +1847,7 @@ void Classify::DoAdaptiveMatch(TBLOB *Blob,
* desired thresholds.
*
* @param Word current word
* @param denorm normalization/denormalization parameters
* @param BestChoice best choice for current word with context
* @param BestRawChoice best choice for current word without context
* @param[out] Thresholds array of thresholds to be filled in
@ -1870,6 +1879,7 @@ void Classify::GetAdaptThresholds(TWERD * Word,
* class which are potential ambiguities.
*
* @param Blob blob to get classification ambiguities for
* @param denorm normalization/denormalization parameters
* @param CorrectClass correct class for Blob
*
* Globals:
@ -1923,6 +1933,7 @@ UNICHAR_ID *Classify::GetAmbiguities(TBLOB *Blob,
* array provided by the caller.
*
* @param Blob blob to extract features from
* @param denorm normalization/denormalization parameters
* @param Templates used to compute char norm adjustments
* @param IntFeatures array to fill with integer features
* @param CharNormArray array to fill with dummy char norm adjustments
@ -2007,10 +2018,14 @@ bool Classify::LooksLikeGarbage(const DENORM& denorm, TBLOB *blob) {
* array provided by the caller.
*
* @param Blob blob to extract features from
* @param denorm normalization/denormalization parameters
* @param Templates used to compute char norm adjustments
* @param IntFeatures array to fill with integer features
* @param PrunerNormArray Array of factors from blob normalization
* process
* @param CharNormArray array to fill with dummy char norm adjustments
* @param BlobLength length of blob in baseline-normalized units
* @param FeatureOutlineArray
*
* Globals:
* - FeaturesHaveBeenExtracted TRUE if fx has been done
@ -2292,6 +2307,7 @@ PROTO_ID Classify::MakeNewTempProtos(FEATURE_SET Features,
* @param Templates current set of adaptive templates
* @param ClassId class containing config to be made permanent
* @param ConfigId config to be made permanent
* @param denorm normalization/denormalization parameters
* @param Blob current blob being adapted to
*
* Globals: none
@ -2354,8 +2370,8 @@ void Classify::MakePermanent(ADAPT_TEMPLATES Templates,
* its proto id is used by the configuration specified in
* ProtoKey.
*
* @param TempProto temporary proto to compare to key
* @param ProtoKey defines which protos to make permanent
* @param item1 (TEMP_PROTO) temporary proto to compare to key
* @param item2 (PROTO_KEY) defines which protos to make permanent
*
* Globals: none
*
@ -2477,7 +2493,7 @@ void Classify::RemoveBadMatches(ADAPT_RESULTS *Results) {
* all good matches get moved to the front of the classes
* array.
*
* @parm Results contains matches to be filtered
* @param Results contains matches to be filtered
*
* Globals:
* - matcher_bad_match_pad defines a "bad match"
@ -2545,9 +2561,12 @@ void Classify::SetAdaptiveThreshold(FLOAT32 Threshold) {
* information for the config which matched best.
*
* @param Blob blob to show best matching config for
* @param denorm normalization/denormalization parameters
* @param ClassId class whose configs are to be searched
* @param shape_id shape index
* @param AdaptiveOn TRUE if adaptive configs are enabled
* @param PreTrainedOn TRUE if pretrained configs are enabled
* @param Results results of match being debugged
*
* Globals:
* - PreTrainedTemplates built-in training

5
classify/featdefs.cpp
View File

@ -190,6 +190,7 @@ CHAR_DESC NewCharDescription(const FEATURE_DEFS_STRUCT &FeatureDefs) {
* Globals:
* - none
*
* @param FeatureDefs definitions of feature types/extractors
* @param File open text file to write CharDesc to
* @param CharDesc character description to write to File
*
@ -249,7 +250,8 @@ bool ValidCharDescription(const FEATURE_DEFS_STRUCT &FeatureDefs,
*
* Globals:
* - none
*
*
* @param FeatureDefs definitions of feature types/extractors
* @param File open text file to read character description from
* @return Character description read from File.
* @note Exceptions:
@ -288,6 +290,7 @@ CHAR_DESC ReadCharDescription(const FEATURE_DEFS_STRUCT &FeatureDefs,
* Globals:
* - none
*
* @param FeatureDefs definitions of feature types/extractors
* @param ShortName short name of a feature type
* @return Feature type which corresponds to ShortName.
* @note Exceptions:

28
classify/intproto.cpp
View File

@ -1808,19 +1808,19 @@ void InitTableFiller (FLOAT32 EndPad, FLOAT32 SidePad,
/*---------------------------------------------------------------------------*/
#ifndef GRAPHICS_DISABLED
/*
* Parameters:
* ShapeList shape list to add feature rendering to
* Feature feature to be rendered
* Color color to use for feature rendering
* Globals: none
* Operation: This routine renders the specified feature into ShapeList.
* Return: New shape list with rendering of Feature added.
* @note Exceptions: none
* @note History: Thu Mar 21 14:57:41 1991, DSJ, Created.
*/
void RenderIntFeature(ScrollView *window, const INT_FEATURE_STRUCT* Feature,
ScrollView::Color color) {
/*
** Parameters:
** ShapeList shape list to add feature rendering to
** Feature feature to be rendered
** Color color to use for feature rendering
** Globals: none
** Operation: This routine renders the specified feature into ShapeList.
** Return: New shape list with rendering of Feature added.
** Exceptions: none
** History: Thu Mar 21 14:57:41 1991, DSJ, Created.
*/
FLOAT32 X, Y, Dx, Dy, Length;
window->Pen(color);
@ -1841,15 +1841,15 @@ void RenderIntFeature(ScrollView *window, const INT_FEATURE_STRUCT* Feature,
/*---------------------------------------------------------------------------*/
/**
/*
* This routine extracts the parameters of the specified
* proto from the class description and adds a rendering of
* the proto onto the ShapeList.
*
* @param ShapeList shape list to append proto rendering onto
* @param ShapeList shape list to append proto rendering onto
* @param Class class that proto is contained in
* @param ProtoId id of proto to be rendered
* @param Color color to render proto in
* @param color color to render proto in
*
* Globals: none
*

2
classify/protos.cpp
View File

@ -414,7 +414,7 @@ int SplitProto(CLASS_TYPE Class, int OldPid) {
/**
* @deprecated
* @nameWriteOldConfigFile
* @name WriteOldConfigFile
*
* Write the configs in the given class to the specified file in the
* old config format.

4
classify/speckle.cpp
View File

@ -96,9 +96,9 @@ void AddLargeSpeckleTo(BLOB_CHOICE_LIST *Choices) {
* Exceptions: none
* History: Mon Mar 11 10:06:49 1991, DSJ, Created.
*
* @param Blob blob to test against speckle criteria
* @param blob blob to test against speckle criteria
*
* @return TRUE if Blob is speckle, FALSE otherwise.
* @return TRUE if blob is speckle, FALSE otherwise.
*/
BOOL8 LargeSpeckle(TBLOB *blob) {
double speckle_size = BASELINE_SCALE * speckle_large_max_size;

6
cutil/oldheap.cpp
View File

@ -67,7 +67,7 @@ HEAP *MakeHeap(int Size) {
*
* @param Heap ptr to heap whose top is to be removed and returned
* @param Key place to put key of top heap item
* @param Data place to put data of top heap item
* @param out_ptr place to put data of top heap item
*
* @return OK if top entry returned, EMPTY if heap is empty
* @note Exceptions: None
@ -119,7 +119,7 @@ int HeapPop(HEAP *Heap, FLOAT32 *Key, void *out_ptr) {
*
* @param Heap ptr to heap whose top is to be removed and returned
* @param Key place to put key of top heap item
* @param Data place to put data of top heap item
* @param out_ptr place to put data of top heap item
*/
int HeapPopWorst(HEAP *Heap, FLOAT32 *Key, void *out_ptr) {
inT32 Index; /*current index */
@ -316,7 +316,7 @@ int GetTopOfHeap(HEAP *Heap, HEAPENTRY *Entry) {
* this data is also deallocated.
*
* @param Heap heap whose data is to be freed
* @param Deallocator function to be used to deallocate data
* @param destructor function to be used to deallocate data
*
* Globals:
* - None

1
image/img.h
View File

@ -223,6 +223,7 @@ class DLLSYM IMAGE
* check coordinates
* @param x xcoord to check
* @param y ycoord to check
* @param xext extent
*/
void check_legal_access(inT32 x,
inT32 y,

2
java/com/google/scrollview/ui/SVPopupMenu.java
View File

@ -105,6 +105,8 @@ public class SVPopupMenu implements ActionListener {
* @param name The caption of the new entry.
* @param id The Id of the new entry. If it is -1, the entry will be treated
* as a menu.
* @param value The value of the new entry.
* @param desc The description of the new entry.
*/
public void add(String parent, String name, int id, String value, String desc) {
SVAbstractMenuItem jmi = items.get(parent);

1
textord/edgblob.cpp
View File

@ -67,7 +67,6 @@ EXTERN double_VAR(edges_boxarea, 0.875,
*/
OL_BUCKETS::OL_BUCKETS(
//// constructor
ICOORD bleft, // corners
ICOORD tright): bl(bleft), tr(tright) {
bxdim =(tright.x() - bleft.x()) / BUCKETSIZE + 1;

4
viewer/scrollview.cpp
View File

@ -761,8 +761,8 @@ void ScrollView::ZoomToRectangle(int x1, int y1, int x2, int y2) {
MIN(x1, x2), MIN(y1, y2), MAX(x1, x2), MAX(y1, y2));
}
// Send an image of type PIX.
void ScrollView::Image(PIX* image, int x_pos, int y_pos) {
// Send an image of type Pix.
void ScrollView::Image(struct Pix* image, int x_pos, int y_pos) {
int width = image->w;
int height = image->h;
l_uint32 bpp = image->d;