/wiki/TagExample.wiki

 1#summary @example
 2
 3== The @example Tag ==
 4
 5The `@example` tag allows you to provide a snippet of code that illustrates the usage of a constructor, a function (or method) or a variable.
 6
 7=== Syntax ===
 8
 9{{{
10@example snippet
11}}}
12
13  * snippet - Required: a snippet of code that illustrates usage.
14  * Multiple `@example` tags are allowed.
15
16=== Example ===
17
18{{{
19/**
20 * @example
21 * var bleeper = makeBleep(3);
22 * bleeper.flop();
23 */
24}}}
25
26=== Note ===
27
28The @example tag is not intended to be used to generate "inline" examples, if 
29you want this, you need to do it via HTML markup embedded within a @description 
30block, using the `<code>` tag, for example.