Template:Orion/ClientAPI

From Eclipsepedia

Jump to: navigation, search

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.