Bug 345428 - Need a way to document service types
Summary: Need a way to document service types
Status: RESOLVED FIXED
Alias: None
Product: Orion (Archived)
Classification: ECD
Component: Client (show other bugs)
Version: 0.2   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: 0.2   Edit
Assignee: John Arthorne CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2011-05-11 10:27 EDT by Mark Macdonald CLA
Modified: 2011-09-01 11:42 EDT (History)
5 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Mark Macdonald CLA 2011-05-11 10:27:20 EDT 
0.2 M7

When I want to contribute a service of a particular type, where do I go for documentation about how my contribution should look? At the moment there is no help, so I have to infer from existing contributions or by looking at the code that ultimately uses them.

I am interested in:
- A description of what the service type is for
- What service properties I must provide
- What methods my service must define

I would like to see a list of all available service types too. It would make sense to include this as part of the client-side documentation.
Comment 1 Boris Bokowski CLA 2011-05-11 13:09:09 EDT 
+1 - something on the Wiki would probably be a good start. John?
Comment 2 John Arthorne CLA 2011-05-12 09:04:16 EDT 
Let me get an initial structure setup, and I'll document it here.
Comment 3 John Arthorne CLA 2011-06-17 15:08:35 EDT 
This structure is now in place on the wiki:

http://wiki.eclipse.org/Orion/Documentation/Developer_Guide

Documentation added there is scraped into the build using WikiText.