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/JSDOCRef"
Line 1: | Line 1: | ||
<includeonly>[http://orion.eclipse.org/jsdoc/symbols/eclipse.{{{1}}}.html#{{{2|}}} {{{3|{{{1}}}{{#if:{{{2|}}}|.|}}{{{2|}}}}}}]</includeonly> | <includeonly>[http://orion.eclipse.org/jsdoc/symbols/eclipse.{{{1}}}.html#{{{2|}}} {{{3|{{{1}}}{{#if:{{{2|}}}|.|}}{{{2|}}}}}}]</includeonly> | ||
+ | <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 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) | ||
+ | {{Usage|<pre>{{Orion/JSDOCRef|FileService|createFile}} | ||
+ | </pre>|2={{Orion/JSDOCRef|FileService|createFile}}}} | ||
+ | |||
+ | ; To render a function link with a given link name | ||
+ | {{Usage|<pre>{{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) | ||
+ | {{Usage|<pre>{{Orion/JSDOCRef|FileService}} | ||
+ | </pre>|2={{Orion/JSDOCRef|FileService}}}} | ||
+ | |||
+ | ; To render a class link with a given link name | ||
+ | {{Usage|<pre>{{Orion/JSDOCRef|FileService||Eclipse Web File Service}} | ||
+ | </pre>|2={{Orion/JSDOCRef|FileService||Eclipse Web File Service}}}} | ||
+ | </noinclude> |
Revision as of 16: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 | |
---|---|---|
|