[JDEV] Technical Documentation

Philip Stephens philip at flatland.com
Fri Mar 31 13:53:30 CST 2000


  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




More information about the JDev mailing list