#6 tess 1.02 docs (via doxyfied sources with doxygen)

[Filip Gieszczykiewicz]

This is the first stab at getting some sort of
cross-referenced documentation of functions, variables
- i.e., nuts and bolts of Tess. It's a lot easier for
me to understand this code by having a browser open in
one window and have instant access to all the
inter-related classes, structures, etc. - while poking
around in the sources in other window(s).

I doxyfied Tess's sources a bit - mostly changes to
comments and select search-n-replaces done by a short
Perl script. Doxygen (I used v1.5) gives some warnings
related to, I suspect, macros being used for list
system (as mentioned in README file) - I'm not sure
doxygen maintainer will wish to incorporate the
necessary changes or even if it's possible (it's a
lexical scanner).

Untar tess_docs01.tar.gz (a bit over 63MB
decompressed!) somewhere handy and point your favorite
browser to html-102/index.html - you should get two
frames with a lot of nifty relationships. Enjoy!

I'm posting this for two reasons:

1) to save anyone else from reinventing this wheel
and
2) in a wish that the maintainers will be interested in
using doxygen commenting commands - very simple! - in
future development. It really makes THEIR comments
later that much more useful to amateurs such as myself
& it eliminates the need for maintenance of separate
documentation. If desired, I can upload the diffs to
the sources (I admit to being ignorant of cvs entirely).

Drat! sourceforge won't let me upload this file (~9mb).
Soooo, you can get it from my site:
1) http://www.repairfaq.org/cgi-bin/United_R.cgi
2) Near the bottom, click on the button that says "list
of all files available
3) Scroll down until you see "Doxyfied Tessearct-1.02
documentation" and click on DOWNLOAD
4) Enter the magic number
5) Be sure to download it from the RFO mirror!
(Sorry, this IS a pain but keeps our BW under
80GB/month :-)

Fmg 10/2006

P.S. I only 'touch up' whatever I am currently hacking,
so this is very much an evolving thing. I'm currently
trying to see how to make tess handle 'streaking' faxes
a lot better than it does now. These are faxes with
vertical lines that go from top to bottom in neat
columns. I don't care about zoning, etc. YET :)

[Filip Gieszczykiewicz]

Logged In: YES
user_id=37894

I have since added a list of main entry points as well as a
list of links to various heuristics used, etc. I've also
tweaked the perl scripts a bit to convert the existing
comments to be more Doxygen compatible.

Any objections to registering a related sf project and
uploading those release there; since the present developers
obviously have lives/wives and real jobs :-)

Cheers,
Fil