Jump to: navigation, search

Template:Orion/APIRef

This is a template for rendering jsdoc APIs as external link. It takes a class name , function name and a desirable link name as parameter. Function name and/or desirable link name are optional. It renders a hyperlink of the JS-DOC URL for the the class or function.

==== Example =====
To render a function link without a given link name(className.functionName is used as link)
Markup Rendering
{{Orion/APIRef|FileService|createFile}}

Refer to FileService.createFile for API details


To render a function link with a given link name
Markup Rendering
{{Orion/APIRef|FileService|createFile|foo}}

Refer to foo for API details


To render a class link without a given link name(className is used as link)
Markup Rendering
{{Orion/APIRef|FileService}}

Refer to FileService for API details


To render a class link with a given link name
Markup Rendering
{{Orion/APIRef|FileService||Eclipse Web File Service}}

Refer to Eclipse Web File Service for API details