Prepare for release 1.77.0. Updated documentation.

* highlevel.html, READEME.html, version-notes.html, comments
  in several utility files (fpix numa, pta, utils).

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = Leptonica
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.76.1
+PROJECT_NUMBER         = 1.77.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.html

@@ -75,12 +75,12 @@
  -  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *====================================================================*/
 
-README (version 1.76.0)
-File update: 1 May 2018
+README (version 1.77.0)
+File update: 14 Dec 2018
 ---------------------------
 
-gunzip leptonica-1.76.0.tar.gz
-tar -xvf leptonica-1.76.0.tar
+gunzip leptonica-1.77.0.tar.gz
+tar -xvf leptonica-1.77.0.tar
 
 </pre>
 
@@ -89,6 +89,7 @@
 <P>
 <A HREF="#BUILDING">Building leptonica</A><br>
 <A HREF="#DEPENDENCIES">I/O libraries leptonica is dependent on</A><br>
+<A HREF="#DOXYGEN">Generating documentation using doxygen</A><br>
 <A HREF="#DEVELOP">Developing with leptonica</A><br>
 <A HREF="#CONTENTS">What's in leptonica?</A><br>
 <P>
@@ -116,7 +117,7 @@ <h2> <A NAME="BUILDING">
   Libraries, executables and prototypes are easily made, as described below.
 
   When you extract from the archive, all files are put in a
-  subdirectory 'leptonica-1.76.0'.  In that directory you will
+  subdirectory 'leptonica-1.77.0'.  In that directory you will
   find a src directory containing the source files for the library,
   and a prog directory containing source files for various
   testing and example programs.
@@ -251,7 +252,7 @@ <h2> <A NAME="BUILDING">
             make install
 
        Configure also supports building in a separate directory from the
-       source.  Run "/(path-to)/leptonica-1.76.0/configure" and then "make"
+       source.  Run "/(path-to)/leptonica-1.77.0/configure" and then "make"
        from the desired build directory.
 
        Configure has a number of useful options; run "configure --help" for
@@ -446,6 +447,23 @@ <h2> <A NAME="DEPENDENCIES">
 </pre>
 
 
+<h2> <A NAME="DOXYGEN">
+Generating documentation using doxygen
+</h2>
+
+<pre>
+The source code is set up to allow generation of documentation using doxygen.
+To do this:
+(1) Download the Debian doxygen package:
+     sudo apt-get install doxygen
+(2) In the root client directory containing Doxyfile:
+     doxygen Doxyfile
+The documentation will be generated in a 'doc' subdirectory, accessible
+from this file (relative to the root)
+    ./doc/html/index.html
+</pre>
+
+
 <h2> <A NAME="DEVELOP">
 Developing with leptonica
 </h2>
@@ -488,7 +506,7 @@ <h2> <A NAME="DEVELOP">
 2. Global parameter to enable development and testing
 
    For security reasons, with the exception of the regression utility
-   (regutils.c), leptonica as shipped (starting with 1.76) does not allow:
+   (regutils.c), leptonica as shipped (starting with 1.77) does not allow:
       * 'system(3)' fork/exec
       * writes to temp files with compiled-in names
    System calls are used either to run gnuplot or display an image on
@@ -1096,8 +1114,8 @@ <h2> <A NAME="CONTENTS">
    http://code.google.com/p/leptonica, as well as all versions after 1.60.
    These have now been transferred by Egor Pugin to github:
        github.com/danbloomberg/leptonica
-   where all releases (1.42 - 1.76.0) are available; e.g.,
-       https://github.com/DanBloomberg/leptonica/releases/tag/1.76.0
+   where all releases (1.42 - 1.77.0) are available; e.g.,
+       https://github.com/DanBloomberg/leptonica/releases/tag/1.77.0
    Most recent releases from 1.67 are also available at
        leptonica.org/download.html
    Note that if you are downloading from github, the releases are more
@@ -1118,6 +1136,7 @@ <h2> <A NAME="CONTENTS">
         1.74 : 5.1.0
         1.75 : 5.2.0
         1.76 : 5.3.0
+        1.77 : 5.3.0
 
    A brief version chronology is maintained in version-notes.html.
    Starting with gcc 4.3.3, error warnings (-Werror) are given for

src/fpix1.c

@@ -28,8 +28,12 @@
  * \file fpix1.c
  * <pre>
  *
- *    This file has basic constructors, destructors and field accessors
- *    for FPix, FPixa and DPix.  It also has uncompressed read/write.
+ *    ---------------------------------------------------
+ *    This file has these FPix, FPixa and DPix utilities:
+ *         - creation and destruction
+ *         - accessors
+ *         - serialization and deserialization
+ *    ---------------------------------------------------
  *
  *    FPix Create/copy/destroy
  *          FPIX          *fpixCreate()

src/fpix2.c

@@ -28,6 +28,7 @@
  * \file fpix2.c
  * <pre>
  *
+ *    ------------------------------------------
  *    This file has these FPix utilities:
  *       ~ interconversions with pix, fpix, dpix
  *       ~ min and max values
@@ -37,6 +38,7 @@
  *       ~ border functions
  *       ~ simple rasterop (source --> dest)
  *       ~ geometric transforms
+ *    ------------------------------------------
  *
  *    Interconversions between Pix, FPix and DPix
  *          FPIX          *pixConvertToFPix()

src/numafunc1.c

@@ -28,6 +28,18 @@
  * \file  numafunc1.c
  * <pre>
  *
+ *      --------------------------------------
+ *      This file has these Numa utilities:
+ *         - arithmetic operations
+ *         - simple data analysis
+ *         - generation of special sequences
+ *         - permutations
+ *         - interpolation
+ *         - sorting
+ *         - data analysis requiring sorting
+ *         - joins and rearrangements
+ *      --------------------------------------
+ *
  *      Arithmetic and logic
  *          NUMA        *numaArithOp()
  *          NUMA        *numaLogicalOp()

src/numafunc2.c

@@ -28,6 +28,17 @@
  * \file  numafunc2.c
  * <pre>
  *
+ *      --------------------------------------
+ *      This file has these Numa utilities:
+ *         - morphological operations
+ *         - arithmetic transforms
+ *         - windowed statistical operations
+ *         - histogram extraction
+ *         - histogram comparison
+ *         - extrema finding
+ *         - frequency and crossing analysis
+ *      --------------------------------------
+
  *      Morphological (min/max) operations
  *          NUMA        *numaErode()
  *          NUMA        *numaDilate()

src/ptafunc1.c

@@ -29,6 +29,16 @@
  * \file  ptafunc1.c
  * <pre>
  *
+ *      --------------------------------------
+ *      This file has these Pta utilities:
+ *         - simple rearrangements
+ *         - geometric analysis
+ *         - min/max and filtering
+ *         - least squares fitting
+ *         - interconversions with Pix and Numa
+ *         - display into a pix
+ *      --------------------------------------
+ *
  *      Simple rearrangements
  *           PTA      *ptaSubsample()
  *           l_int32   ptaJoin()

src/ptafunc2.c

@@ -28,6 +28,13 @@
  * \file  ptafunc2.c
  * <pre>
  *
+ *      --------------------------------------
+ *      This file has these Pta utilities:
+ *         - sorting
+ *         - ordered set operations
+ *         - hash map operations
+ *      --------------------------------------
+ *
  *      Sorting
  *           PTA        *ptaSort()
  *           l_int32     ptaGetSortIndex()

src/utils1.c

@@ -28,6 +28,17 @@
  * \file utils1.c
  * <pre>
  *
+ *       ------------------------------------------
+ *       This file has these utilities:
+ *         - error, warning and info messages
+ *         - low-level endian conversions
+ *         - file corruption operations
+ *         - random and prime number operations
+ *         - 64-bit hash functions
+ *         - leptonica version number accessor
+ *         - timing and date operations
+ *       ------------------------------------------
+ *
  *       Control of error, warning and info messages
  *           l_int32    setMsgSeverity()
  *

src/utils2.c

@@ -28,6 +28,15 @@
  * \file utils2.c
  * <pre>
  *
+ *      ------------------------------------------
+ *      This file has these utilities:
+ *         - safe string operations
+ *         - find/replace operations on strings
+ *         - read/write between file and memory
+ *         - multi-platform file and directory operations
+ *         - file name operations
+ *      ------------------------------------------
+ *
  *       Safe string procs
  *           char      *stringNew()
  *           l_int32    stringCopy()

version-notes.html

@@ -77,7 +77,7 @@
 
 
 <h2 align=center>Version Notes for Leptonica</h2>
-<h3 align=center>21 Jun 2018</h3>
+<h3 align=center>14 Dec 2018</h3>
 
 <hr>
 <h2 align=center>  <IMG SRC="moller52.jpg" border=1 ALIGN_MIDDLE> </h2>
@@ -89,7 +89,7 @@ <h2 align=center>  <IMG SRC="moller52.jpg" border=1 ALIGN_MIDDLE> </h2>
 
 <pre>
 
-1.77.0  To be released
+1.77.0  14 Dec 18
         Here is the current status of CVE issues with leptonica; see
           https://security-tracker.debian.org/tracker/source-package/leptonlib
         * CVE-2018-7442: potential injection attack because '/' is allowed
@@ -154,6 +154,7 @@ <h2 align=center>  <IMG SRC="moller52.jpg" border=1 ALIGN_MIDDLE> </h2>
         Fixed uninitialized data in pixCentroid() on 1 bpp pix.
         New reg test: bytea_reg.c.  (removed byteatest.c)
         Fixed bug in non-transcoding pdf generation from 1 bpp png.
+        Added LGTM to static analyzers that run over the library.
 
 1.76.0  1 May 18
         Modify infrastructure to fix outstanding security issues. By default,