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/JSDOCRef"
| (11 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <noinclude> | + | <noinclude>This is a template for rendering jsdoc APIs as external link. |
| − | 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. | It takes a class name , function name and a desirable link name as parameter. | ||
Function name and/or desirable link name are optional. | Function name and/or desirable link name are optional. | ||
It renders a hyperlink of the JS-DOC URL for the the class or function. | It renders a hyperlink of the JS-DOC URL for the the class or function. | ||
| − | |||
; ==== Example ===== | ; ==== Example ===== | ||
| − | |||
; To render a function link without a given link name(className.funcionName is used as link) | ; To render a function link without a given link name(className.funcionName is used as link) | ||
{{Usage|<pre>{{Orion/JSDOCRef|FileService|createFile}} | {{Usage|<pre>{{Orion/JSDOCRef|FileService|createFile}} | ||
</pre>|2={{Orion/JSDOCRef|FileService|createFile}}}} | </pre>|2={{Orion/JSDOCRef|FileService|createFile}}}} | ||
| − | |||
; To render a function link with a given link name | ; To render a function link with a given link name | ||
{{Usage|<pre>{{Orion/JSDOCRef|FileService|createFile|foo}} | {{Usage|<pre>{{Orion/JSDOCRef|FileService|createFile|foo}} | ||
</pre>|2={{Orion/JSDOCRef|FileService|createFile|foo}}}} | </pre>|2={{Orion/JSDOCRef|FileService|createFile|foo}}}} | ||
| − | |||
; To render a class link without a given link name(className is used as link) | ; To render a class link without a given link name(className is used as link) | ||
{{Usage|<pre>{{Orion/JSDOCRef|FileService}} | {{Usage|<pre>{{Orion/JSDOCRef|FileService}} | ||
</pre>|2={{Orion/JSDOCRef|FileService}}}} | </pre>|2={{Orion/JSDOCRef|FileService}}}} | ||
| − | |||
; To render a class link with a given link name | ; To render a class link with a given link name | ||
{{Usage|<pre>{{Orion/JSDOCRef|FileService||Eclipse Web File Service}} | {{Usage|<pre>{{Orion/JSDOCRef|FileService||Eclipse Web File Service}} | ||
| − | </pre>|2={{Orion/JSDOCRef|FileService||Eclipse Web File Service}}}} | + | </pre>|2={{Orion/JSDOCRef|FileService||Eclipse Web File Service}}}}</noinclude><includeonly>[http://orion.eclipse.org/jsdoc/symbols/eclipse.{{{1}}}.html#{{{2|}}} {{{3|{{{1}}}{{#if:{{{2|}}}|.|}}{{{2|}}}}}}]</includeonly> |
| − | </noinclude> | + | |
| − | + | ||
| − | <includeonly>[http://orion.eclipse.org/jsdoc/symbols/eclipse.{{{1}}}.html | + | |
Latest revision as of 18:21, 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.funcionName is used as link)
| Markup | Rendering | |
|---|---|---|
|
- To render a function link with a given link name
| Markup | Rendering | |
|---|---|---|
|
- To render a class link without a given link name(className is used as link)
| Markup | Rendering | |
|---|---|---|
|
- To render a class link with a given link name
| Markup | Rendering | |
|---|---|---|
|