Skip to main content
Jump to: navigation, search

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>
;Functon
+
;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
{{Orion/ClientAPI
| function = getChildren(parentItem, updateFunction)
| overview = get Children of a folder
| parameters = parentItem
| return = error
| example = example
| explain = Detailed explanation
}}
Function
getChildren(parentItem, updateFunction)
Overview
get Children of a folder
Parameters
parentItem
Return Value
error
Example Code
example
Detailed Explanation
Detailed explanation


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.



Back to the top