Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Template:Orion/DocAPIRef"
(New page: <noinclude> 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 wiki...) |
(No difference)
|
Revision as of 13:36, 14 June 2011
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 | |
|---|---|---|
|
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 |