[sword-devel] API Documentation

Andrew Sterling Hanenkamp sterling at hanenkamp.com
Sun Aug 12 07:43:14 MST 2007


I must be a little slow this morning. I found that the code does seem to be
better documented than I'd originally thought. I was looking the wrong place
(got too used to Perl and Java coding latestly).

Is there a way to build doxygen or similar docs already in place?

On 8/12/07, Andrew Sterling Hanenkamp <sterling at hanenkamp.com> wrote:
>
> I was looking into getting started into some of the SWIG stuff today, but
> stopped short because there's really no API documentation. I think that's
> tantamount if the Sword project wants more developer help. I notice that the
> doc/ directory in the distro contains a README stating "No real good docs
> for developers yet, but see tutorials and primers on our website." The
> primers and tutorials really just scratch the surface though, from what I
> can tell.
>
> Any opposition for me setting up doxygen (or something else if someone has
> another preference) and starting to go through and adding API doc comments?
>
> Cheers,
> Sterling
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.crosswire.org/pipermail/sword-devel/attachments/20070812/6e4c5878/attachment.html 


More information about the sword-devel mailing list