|
|
| Line 1: |
Line 1: |
| | <noinclude> | | <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 wikitext into official Orion documentation. It takes a class name , function name and a desirable link name as parameter. | + | This template is not in use. |
| − | Function name and/or desirable link name are optional.
| + | </noinclude> |
| − | 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)
| + | |
| − | {{Usage|<pre>{{Orion/DocAPIRef|FileService|createFile}}
| + | |
| − | </pre>|2={{Orion/DocAPIRef|FileService|createFile}}}}
| + | |
| − | | + | |
| − | ; To render a function link with a given link name
| + | |
| − | {{Usage|<pre>{{Orion/DocAPIRef|FileService|createFile|foo}}
| + | |
| − | </pre>|2={{Orion/DocAPIRef|FileService|createFile|foo}}}}
| + | |
| − | | + | |
| − | ; To render a class link without a given link name(className is used as link)
| + | |
| − | {{Usage|<pre>{{Orion/DocAPIRef|FileService}}
| + | |
| − | </pre>|2={{Orion/DocAPIRef|FileService}}}}
| + | |
| − | | + | |
| − | ; To render a class link with a given link name
| + | |
| − | {{Usage|<pre>{{Orion/DocAPIRef|FileService||Eclipse Web File Service}}
| + | |
| − | </pre>|2={{Orion/DocAPIRef|FileService||Eclipse Web File Service}}}}
| + | |
| − | </noinclude><includeonly>Refer to <a href="/help/topic/org.eclipse.orion.doc.isv/jsdoc/symbols/{{{1}}}.html#{{{2|}}}">{{{3|{{{1}}}{{#if:{{{2|}}}|.|}}{{{2|}}}}}}</a> for API details</includeonly> | + | |
Latest revision as of 14:07, 14 June 2011
This template is not in use.
