Notice: this Wiki will be going read only early in 2024 and edits will no longer be 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...) |
m (Fixed https://bugs.eclipse.org/bugs/show_bug.cgi?id=334013) |
||
| Line 39: | Line 39: | ||
<includeonly> | <includeonly> | ||
| − | ; | + | ;Function |
:{{{function}}} | :{{{function}}} | ||
;Overview | ;Overview | ||
Latest revision as of 09:16, 12 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.