DJDoc - Frequently Asked Questions


My API is registered in the DJDoc installation as described, yet I see no difference between what gets displayed by DJDoc and what the standard JavaDoc produces. What's wrong?
The currently available version of DJDoc is labeled as beta state. What's missing for a full GA state version?
Are there any plans for additional features to be included in a followup version of DJDoc?

My API is registered in the DJDoc installation as described, yet I see no difference between what gets displayed by DJDoc and what the standard JavaDoc produces. What's wrong?

One cause may be that the frameset of the registered API consists of two frames only (this is usually the case if the JavaDoc API documentation has been generated for one package only). In this case, displaying the documentation via DJDoc has no effect.

 

The currently available version of DJDoc is labeled as beta state. What's missing for a full GA state version?

The main issue still under development is robustness regarding timeouts of database connections and HTTP sessions.
NOTE: There appears to be a problem with Hibernate's connection pool which causes exceptions after a longer period of inactivity. Including a third-party connection pool such as the (open source) C3P0 connection pool seems to fix these.

Another problematic area is inconsistencies during concurrent access to a system running with SameUserStrategy.

Finally, to ensure GA quality, more unit tests as well as functional tests need to be implemented.

 

Are there any plans for additional features to be included in a followup version of DJDoc?

Of course, the future development of the application depends greatly on the feedback from users, but a few things that may make their way into a 2.0 version are:

  1. Support for JavaDoc style documentation not generated by JavaDoc (such as TLDDoc), including additional (perhaps even custom) item types.

  2. Additional configurability, e.g. for the size of the HitLists or the duration of the cookie used by the SimpleUserStrategy.

  3. Monitoring of the file systems of the registered API for ability to react to changes in the API documentation.

  4. Support for "remote" API documentation (not available via the file system but via HTTP).
  5. An administration module for online modification of things like Hibernate settings, logging configuration, perhaps even for database side tasks such as DJDoc user administration.