mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 00:25:27 +00:00
68 lines
2.1 KiB
XML
68 lines
2.1 KiB
XML
<?xml version='1.0' encoding='ISO-8859-1' standalone='yes'?>
|
|
<!DOCTYPE api>
|
|
<API id='basic test 1'>
|
|
<HEAD>
|
|
This is the heading.
|
|
</HEAD>
|
|
<FOOT>
|
|
Don't look here!
|
|
</FOOT>
|
|
<EXTERNALREF name="LXR ID Lookup" value="http://lxr.mozilla.org/mozilla/ident?i={e}"/>
|
|
<ENTRY id="foo">
|
|
<TYPE value="Function"/>
|
|
<SUMMARY>
|
|
<C>foo</C> is cool.
|
|
</SUMMARY>
|
|
<DESCRIPTION>
|
|
<C>foo</C> is the function you want to use. Other functions
|
|
like <C>bar</C> and <C>baz</C> aren't half as good as foo.
|
|
The <S>JSBot page</S> is badly out of date. The <S>Function</S>
|
|
group has other functions in this api.
|
|
</DESCRIPTION>
|
|
<SYNTAX>
|
|
void foo(int x, float y)
|
|
<PARAM name="x" type="int">
|
|
Does what x does.
|
|
</PARAM>
|
|
<PARAM name="y" type="float">
|
|
Does what y does, better than x.
|
|
</PARAM>
|
|
</SYNTAX>
|
|
<EXAMPLE desc="Do it like this or you will suffer!">
|
|
foo (1, 2) /* calls foo */
|
|
foo (3, 4) /* calls foo with better arguments*/
|
|
</EXAMPLE>
|
|
<EXTERNALREF name="JSBot page" value="http://www.ndcico.com/jsbot"/>
|
|
<SEEALSO value="bar"/>
|
|
</ENTRY>
|
|
|
|
<ENTRY id="bar">
|
|
<DEPRECATED/>
|
|
<TYPE value="Function"/>
|
|
<SUMMARY>
|
|
<C>bar</C> is lame.
|
|
</SUMMARY>
|
|
<DESCRIPTION>
|
|
<C>bar</C> is less than half as good as <C>foo</C>.
|
|
</DESCRIPTION>
|
|
<SYNTAX>
|
|
void bar(int x, float y)
|
|
<PARAM name="x" type="int">
|
|
Does what x does.
|
|
</PARAM>
|
|
<PARAM name="y" type="float">
|
|
Does what y does, better than x.
|
|
</PARAM>
|
|
</SYNTAX>
|
|
<EXAMPLE desc="Do it like this or you will suffer!">
|
|
bar (1, 2) /* calls bar */
|
|
bar (3, 4) /* calls bar with worser arguments*/
|
|
</EXAMPLE>
|
|
<GROUP name="Useless Functions"/>
|
|
</ENTRY>
|
|
|
|
<GROUP name="Useless Functions" value="bar"/>
|
|
<GROUP name="Cool Functions" value="foo"/>
|
|
|
|
</API>
|