Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Template:Orion/JSDOCRef"

Line 24: Line 24:
 
</noinclude>
 
</noinclude>
  
<includeonly>{{#if:{{{2|}}}|[http://orion.eclipse.org/jsdoc/symbols/eclipse.{{{1}}}.html#{{{2|}}} {{{3|{{{1}}}.{{{2|}}}]|[http://orion.eclipse.org/jsdoc/symbols/eclipse.{{{1}}}.html {{{3|{{{1}}}}}}]}}</includeonly>
+
<includeonly>[http://orion.eclipse.org/jsdoc/symbols/eclipse.{{{1}}}.html#{{{2|}}} {{{3|{{{1}}}{{#if:{{{2|}}}|.|}}{{{2|}}}}}}]</includeonly>

Revision as of 17:33, 10 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
{{Orion/JSDOCRef|FileService|createFile}}

FileService.createFile


To render a function link with a given link name
Markup Rendering
{{Orion/JSDOCRef|FileService|createFile|foo}}

foo


To render a class link without a given link name(className is used as link)
Markup Rendering
{{Orion/JSDOCRef|FileService}}

FileService


To render a class link with a given link name
Markup Rendering
{{Orion/JSDOCRef|FileService||Eclipse Web File Service}}

Eclipse Web File Service



Back to the top