Summary: | document is out of date, incomplete and not useful to JPA users | ||
---|---|---|---|
Product: | z_Archived | Reporter: | James Sutherland <jamesssss> |
Component: | Eclipselink | Assignee: | Project Inbox <eclipselink.documentation-inbox> |
Status: | REOPENED --- | QA Contact: | |
Severity: | major | ||
Priority: | P3 | CC: | rick.sapir |
Version: | unspecified | Keywords: | Documentation |
Target Milestone: | --- | Flags: | rick.sapir:
documentation+
|
Hardware: | PC | ||
OS: | Windows XP | ||
URL: | http://wiki.eclipse.org/EclipseLink/UserGuide/JPA | ||
Whiteboard: |
Description
James Sutherland
2010-06-14 15:38:33 EDT
EclipseLink JPA User Guide being re-developed: http://wiki.eclipse.org/EclipseLink/UserGuide/JPA See new EclipseLink documentation, including JPA Extensions guide: http://eclipse.org/eclipselink/documentation The new Extensions guide does provide documentation to all annotations, so is up to date. But it is still incomplete, in that it gives no context to why the annotations would be used, and does not document the concepts behind the features the annotations are part of the support for. It is still a very useful reference, but cannot be considered complete documentation. Also many features that are not reflected in annotation are not documented at all (events, history, custom sql, cache API, VPD), nor are the JPA concepts (caching, locking, transactions, querying, mapping, jpql, criteria). The User Guide is a big step towards better documentation, it removes the confusion over the old API and puts things in a JPA perspective. But it is incomplete, missing documentation on some key features. It also seems like it is no longer being maintained. The Eclipselink project has moved to Github: https://github.com/eclipse-ee4j/eclipselink |