This is a template for rendering jsdoc APIs as a relative link within the Orion documentation. This template should only be used in wiki pages that are being converted via wikitext into official Orion documentation. 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/DocAPIRef|FileService|createFile}}
|
|
|
- To render a function link with a given link name
Markup |
Rendering
|
{{Orion/DocAPIRef|FileService|createFile|foo}}
|
|
|
- To render a class link without a given link name(className is used as link)
Markup |
Rendering
|
{{Orion/DocAPIRef|FileService}}
|
|
|
- To render a class link with a given link name
Markup |
Rendering
|
{{Orion/DocAPIRef|FileService||Eclipse Web File Service}}
|
|
|