Skip to content
This repository has been archived by the owner on Mar 17, 2022. It is now read-only.

Commit

Permalink
Fix javadocs errors and warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
Robyer committed Apr 27, 2017
1 parent 3debecf commit 7792a02
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 12 deletions.
10 changes: 5 additions & 5 deletions tess-two/src/com/googlecode/leptonica/android/Binarize.java
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ public static Pix sauvolaBinarizeTiled(Pix pixs) {
* Notes:
* <ol>
* <li> The window width and height are 2 * whsize + 1. The minimum
* value for whsize is 2; typically it is >= 7.
* value for whsize is 2; typically it is &gt;= 7.
* <li> For nx == ny == 1, this defaults to pixSauvolaBinarize().
* <li> Why a tiled version?
* (a) Because the mean value accumulator is a uint32, overflow
Expand All @@ -169,7 +169,7 @@ public static Pix sauvolaBinarizeTiled(Pix pixs) {
* where:
* t = local threshold
* m = local mean
* k = @factor (>= 0) [ typ. 0.35 ]
* k = @factor (&gt;= 0) [ typ. 0.35 ]
* s = local standard deviation, which is maximized at
* 127.5 when half the samples are 0 and half are 255.
* <li> The basic idea of Niblack and Sauvola binarization is that
Expand All @@ -180,9 +180,9 @@ public static Pix sauvolaBinarizeTiled(Pix pixs) {
*
* @param pixs An 8 bpp PIX source image.
* @param whsize Window half-width for measuring local statistics
* @param factor Factor for reducing threshold due to variance; >= 0
* @param nx Subdivision into tiles; >= 1
* @param ny Subdivision into tiles; >= 1
* @param factor Factor for reducing threshold due to variance; &gt;= 0
* @param nx Subdivision into tiles; &gt;= 1
* @param ny Subdivision into tiles; &gt;= 1
* @return A 1 bpp thresholded PIX image.
*/
public static Pix sauvolaBinarizeTiled(Pix pixs, int whsize, float factor, int nx, int ny) {
Expand Down
1 change: 0 additions & 1 deletion tess-two/src/com/googlecode/leptonica/android/Clip.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ public class Clip {
* This should be simple, but there are choices to be made. The box is
* defined relative to the pix coordinates. However, if the box is not
* contained within the pix, we have two choices:
* <p>
* <p> (1) clip the box to the pix
* <p> (2) make a new pix equal to the full box dimensions,
* but let rasterop do the clipping and positioning
Expand Down
1 change: 0 additions & 1 deletion tess-two/src/com/googlecode/leptonica/android/Edge.java
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ public class Edge {
* using pixThresholdToBinary(). If the high edge values are to be fg (1),
* invert after running pixThresholdToBinary().
* <li> Label the pixels as follows:
* <p>
* <p> 1 4 7
* <p> 2 5 8
* <p> 3 6 9
Expand Down
4 changes: 2 additions & 2 deletions tess-two/src/com/googlecode/leptonica/android/MorphApp.java
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ public static Pix pixFastTophatWhite(Pix pixs) {
* </ol>
*
* @param pixs Source pix (8bpp)
* @param xsize width of max/min op, smoothing; any integer >= 1
* @param ysize height of max/min op, smoothing; any integer >= 1
* @param xsize width of max/min op, smoothing; any integer &gt;= 1
* @param ysize height of max/min op, smoothing; any integer &gt;= 1
* @param type L_TOPHAT_WHITE: image - min, or L_TOPHAT_BLACK: max - image
* @return a new Pix image
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,15 @@ public boolean next(int level) {
* ============= Accessing data ==============.
* <p>
* Coordinate system:
* <p><ul>
* <ul>
* <li> Integer coordinates are at the cracks between the pixels.
* <li> The top-left corner of the top-left pixel in the image is at (0,0).
* <li> The bottom-right corner of the bottom-right pixel in the image is at
* (width, height).
* <li> Every bounding box goes from the top-left of the top-left contained
* pixel to the bottom-right of the bottom-right contained pixel, so
* the bounding box of the single top-left pixel in the image is:
* (0,0)->(1,1).
* (0,0)-&gt;(1,1).
* <li> If an image rectangle has been set in the API, then returned coordinates
* relate to the original (full) image, rather than the rectangle.
* </ul><p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ public TessBaseAPI(ProgressNotifier progressNotifier) {
* multiple times on the same instance to change language, or just to reset
* the classifier.
* <p>
* The language may be a string of the form [~]<lang>[+[~]<lang>]* indicating
* The language may be a string of the form {@code [~]<lang>[+[~]<lang>]*} indicating
* that multiple languages are to be loaded. Eg hin+eng will load Hindi and
* English. Languages may specify internally that they want to be loaded
* with one or more other languages, so the ~ sign is available to override
Expand Down

0 comments on commit 7792a02

Please sign in to comment.