[sword-devel] Sword Docs

[Greg Hellings]

Hi,

I've been rather frantic in scrambling around trying to locate source
files and class hierarchies and inheritance information in the
library.  I remember someone used to have a nice set of documentation
for the system up on the Crosswire server that had been generated with
Doxygen, but I believe it was out of date at the time, which was going
on a few years back already (1.5.8 or 1.5.7 -- something like that).
As such, I've dropped out some Doxygen HTML docs from the current
source tree in SVN and placed them in
http://www.crosswire.org/~ghellings/svnclassdocs/.  If there's
something nagging at you about the format of them, etc, I can try to
fiddle with the Doxygen configuration file to see if it can be
modified.  I elected to have it output the graphs, etc, using UML-like
syntax, seeing as it will probably be the best understood format for
such diagrams.

One useful side-effect of having the documentation is that it can be
an easy reference for which methods and members are NOT documented
(and probably should be).  Essentially, any method or member which is
not a link in the class page, is an undocumented (or possibly has
non-doxygen-formatted documentation) portion of the engine.
Documentation is often a place where newcomers to a project can fit in
well while they learn the ins and outs of the code.

--Greg