Template:Orion/JSDOCRef

From Eclipsepedia

Jump to: navigation, search

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.funcionName is used as link)
Markup Rendering
{{Orion/JSDOCRef|FileService|createFile}}

FileService.createFile

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

foo

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

FileService

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

Eclipse Web File Service