[JDEV] Technical Documentation

[temas]

I 100% agree.  I'm horrible about commenting code as I go, because primarily
myself and jer are the only ones acknowledgin to have touched the code, and
we use similar styles.    I'm making a concious effort to be better at that,
and I'll beat jer with a cluebat of some sort to get him to do it to =).  As
for the overview materials, I hope to have a general overview done in a while.
I'm finishing up some layout for all of the IQ and X stuff so that others can
work on that, then I'll move on to the overview document.  After that I think
I will return to work on IQs.

--temas

On Fri, Mar 31, 2000 at 11:53:30AM -0800, Philip Stephens wrote:
>   I agree with Kimmo P Hamalainen that the entire project needs some
> documentation to explain the structure of the code and the data
> structures, both for the server and the client libraries.
> 
>   Right now I can't find documentation on the Module and Service APIs
> for the server, and the documentation for the JabberCOM client API has
> insufficient detail and is presented in Delphi syntax only!
> 
>   Also, there needs to be thorough overview of Jabber.  In all the
> documentation I have seen so far, there hasn't even been a definition of
> a "resource", nor a decent definition of "presence".  Some of the basic
> concepts that Jabber has been founded on are simply not well described.
> 
>   I would love to use Jabber in a project, but without good overviews of
> the system, and good technical docs for the source code, it's going to
> take me too long to figure out how to use and modify Jabber to make it
> worth my while.
> 
>   I could go on about how developers working on this project should make
> it their business to include copious comments in their source and
> maintain docs on their design, but I won't ;-)
> 
>   Regards,
>   Philip Stephens
> 
> _______________________________________________
> jdev mailing list
> jdev at jabber.org
> http://mailman.jabber.org/listinfo/jdev
> 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 232 bytes
Desc: not available
URL: <https://www.jabber.org/jdev/attachments/20000331/23cd78b8/attachment-0002.pgp>