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/APIRef"

Line 22: Line 22:
 
{{Usage|<pre>{{Orion/APIRef|FileService||Eclipse Web File Service}}
 
{{Usage|<pre>{{Orion/APIRef|FileService||Eclipse Web File Service}}
 
</pre>|2={{Orion/APIRef|FileService||Eclipse Web File Service}}}}
 
</pre>|2={{Orion/APIRef|FileService||Eclipse Web File Service}}}}
</noinclude><includeonly>Refer to [http://orion.eclipse.org/jsdoc/symbols/eclipse.{{{1}}}.html#{{{2|}}} {{{3|{{{1}}}{{#if:{{{2|}}}|.|}}{{{2|}}}}}}] for API details.</includeonly>
+
</noinclude><includeonly>Refer to [http://orion.eclipse.org/jsdoc/symbols/eclipse.{{{1}}}.html#{{{2|}}} {{{3|{{{1}}}{{#if:{{{2|}}}|.|}}{{{2|}}}}}}] for API details</includeonly>

Revision as of 12:51, 12 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
{{Orion/APIRef|FileService|createFile}}

Refer to FileService.createFile for API details


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

Refer to foo for API details


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

Refer to FileService for API details


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

Refer to Eclipse Web File Service for API details


Back to the top