[Objectbridge-jdo-dev] documentation of java packages

[Budde, F. <fri...@vi...>]

Hi,
since I volunteered for documenting the project I'd like to ask you for
comments about a java package documentation template for docbook I've made
up during the weekend.
To put it to the test I chose the (simply structured) java package
ojb.broker.cache.

I've attached
- the html version of the documentation template,
- the html version of the documentation of ojb.broker.cache,
- a gif of a class diagram of ojb.broke.cache made with poseidon and
- the xml version of the documentation of ojb.broker.cache.

I'd appreciate any kind of comment on the template (and the cache
documentation). Especially I'd like to know:
Do you think the information is relevant?
Too much/little detail?
Which kind of documentation did you miss?
Is the information presented in the right order/hierachy?
What do you think about the format docbook?
Thanks in advance for your comments.

Of course there is still a lot to do
- Create a stylesheet to improve the graphical 
  representation of the documentation (Currently it looks 
  much nicer in the XXE editor than in the browser)
- Customize the xsl docbook stylesheet to integrate
  the generated html with javadoc

Awaiting your replies
  Frido

PS: English is not my native language. Therefore I'd very much appreciate
any hints on incorrectly used words or phrases because I think that
documentation should be as accurate and intelligible as possible.