Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Template:Orion/ClientAPI"
(New page: <noinclude> This is a template for documenting Client Service APIs. {{Usage|<pre>{{Orion/ClientAPI | function = getChildren(parentItem, updateFunction) | overview = get Children of a fold...) |
(No difference)
|
Revision as of 17:28, 10 January 2011
This is a template for documenting Client Service APIs.
Markup | Rendering | |
---|---|---|
|
example
|
Function
- The Service Function
Overview
- A textual overview of the purpose of the function
parameters
- The parameters of the function
return
- The return value of the function
example
- The example of the function usage
Explain
- Detailed explanation of this function.