Skip to main content

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.

Jump to: navigation, search

Template:Orion/ClientAPI

Revision as of 09:16, 12 January 2011 by Tomasz.Zarna.pl.ibm.com (Talk | contribs) (Fixed https://bugs.eclipse.org/bugs/show_bug.cgi?id=334013)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.



Copyright © Eclipse Foundation, Inc. All Rights Reserved.