Task #161 (closed)
Opened 13 years ago
Closed 13 years ago
Documentation for Query Factory and Query Lookup
| Reported by: | cxallan | Owned by: | jamoore |
|---|---|---|---|
| Priority: | minor | Milestone: | 3.0-M2 |
| Component: | Documentation | Version: | 3.0-M2 |
| Keywords: | iteration4,queries | Cc: | |
| Resources: | n.a. | Referenced By: | n.a. |
| References: | n.a. | Remaining Time: | n.a. |
| Sprint: | n.a. |
Description
Currently the query factory and query lookup (in particular used by the IPojos service) are not documented.
What's probably needed are:
- Javadoc for methods
- Instructions on how to add new queries
Change History (5)
comment:1 Changed 13 years ago by cxallan
- Type changed from User Story to Task
comment:2 Changed 13 years ago by jmoore
- Keywords iteration4 added
- Milestone changed from Unscheduled to 3.0-M2
comment:3 Changed 13 years ago by jmoore
comment:4 Changed 13 years ago by jmoore
Added simple collaboration diagram on tiki at Omero+Queries
comment:5 Changed 13 years ago by jmoore
- Keywords queries added
- Resolution set to fixed
- Status changed from new to closed
Updated Omero+Queries with a short section on creating Queries. It's not extensive, but unless this horribly fails the mark, let's leave this one closed until someone needs more on Queries. (Otherwise, we have lots of doc on queries and nothing else.)
r727 updates almost all documentation. The best starting point is the package.html which is best viewed from the generated javadocs. After that, it's still a matter of clicking through the files, reading javadocs.
Probably a tiki design page still needs to be written up.