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.
Difference between revisions of "Template:Orion/APIRef"
(New page: <noinclude> 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 ...) |
|||
| Line 7: | Line 7: | ||
; ==== Example ===== | ; ==== Example ===== | ||
| − | ; To render a function link without a given link name(className. | + | ; To render a function link without a given link name(className.functionName is used as link) |
{{Usage|<pre>{{Orion/APIRef|FileService|createFile}} | {{Usage|<pre>{{Orion/APIRef|FileService|createFile}} | ||
</pre>|2={{Orion/APIRef|FileService|createFile}}}} | </pre>|2={{Orion/APIRef|FileService|createFile}}}} | ||
Revision as of 10:48, 11 January 2011
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 | |
|---|---|---|
|
Refer to FileService.createFile for API details |
- To render a function link with a given link name
| Markup | Rendering | |
|---|---|---|
|
Refer to foo for API details |
- To render a class link without a given link name(className is used as link)
| Markup | Rendering | |
|---|---|---|
|
Refer to FileService for API details |
- To render a class link with a given link name
| Markup | Rendering | |
|---|---|---|
|
Refer to Eclipse Web File Service for API details |