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.
Template:Orion/ClientAPI
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.