autotests/reference/test.Rd.ref

0001 <Comment>% Single-line comment</Comment><br/>
0002 <Section>\name</Section><Brace>{</Brace><ItemName>foo</ItemName><Brace>}</Brace><br/>
0003 <Preprocessor>#ifdef </Preprocessor><Builtin>unix</Builtin><br/>
0004 <Section>\alias</Section><Brace>{</Brace><Verbatim>bar</Verbatim><Brace>}</Brace><br/>
0005 <Preprocessor>#endif</Preprocessor><Comment> ignored</Comment><br/>
0006 <Section>\title</Section><Brace>{</Brace><NormalText>Foo</NormalText><Brace>}</Brace><br/>
0007 <Section>\description</Section><Brace>{</Brace><br/>
0008 <NormalText>    We have a list</NormalText><br/>
0009 <NormalText>    </NormalText><Markup>\itemize</Markup><Brace>{</Brace><br/>
0010 <NormalText>        </NormalText><Markup>\item</Markup><NormalText> foo,</NormalText><br/>
0011 <NormalText>        </NormalText><Markup>\item</Markup><NormalText> bar.</NormalText><br/>
0012 <NormalText>    </NormalText><Brace>}</Brace><br/>
0013 <NormalText>    Also a table: </NormalText><Markup>\tabular</Markup><Brace>{</Brace><Verbatim>lr</Verbatim><Brace>}{</Brace><br/>
0014 <NormalText>        foo </NormalText><UserDefinedMacro>\tab</UserDefinedMacro><NormalText> </NormalText><Markup>\code</Markup><Brace>{</Brace><Verbatim>foo</Verbatim><Brace>}</Brace><NormalText> </NormalText><UserDefinedMacro>\cr</UserDefinedMacro><br/>
0015 <NormalText>        bar </NormalText><UserDefinedMacro>\tab</UserDefinedMacro><NormalText> </NormalText><Markup>\preformatted</Markup><Brace>{</Brace><Verbatim>bar</Verbatim><Brace>}</Brace><br/>
0016 <NormalText>    </NormalText><Brace>}</Brace><br/>
0017 <NormalText>    </NormalText><Markup>\samp</Markup><Error> error</Error><Brace>{</Brace><NormalText>code</NormalText><Brace>}</Brace><br/>
0018 <Brace>}</Brace><br/>
0019 <Section>\section</Section><Brace>{</Brace><ItemName>Section</ItemName><Brace>}{</Brace><br/>
0020 <NormalText>    Escaped braces don't need balance </NormalText><Escape>\}</Escape><br/>
0021 <NormalText>    </NormalText><Section>\subsection</Section><Brace>{</Brace><ItemName>Subsection</ItemName><Brace>}{</Brace><br/>
0022 <NormalText>        </NormalText><Section>\subsection</Section><Brace>{</Brace><ItemName>Subsubsection</ItemName><Brace>}{</Brace><br/>
0023 <NormalText>            Sections can be nested.</NormalText><br/>
0024 <NormalText>        </NormalText><Brace>}</Brace><br/>
0025 <NormalText>    </NormalText><Brace>}</Brace><br/>
0026 <Brace>}</Brace><br/>
0027 <Section>\usage</Section><Brace>{</Brace><br/>
0028 <Keyword>foo</Keyword><Symbol>(</Symbol><Normal Text>a, </Normal Text><Identifier>b =</Identifier><Normal Text> default</Normal Text><Symbol>)</Symbol><br/>
0029 <Markup>\method</Markup><Brace>{</Brace><ItemName>[</ItemName><Brace>}{</Brace><NormalText>foo</NormalText><Brace>}</Brace><Symbol>(</Symbol><Normal Text>x, \dots</Normal Text><Symbol>)</Symbol><br/>
0030 <Brace>}</Brace><br/>
0031 <Markup>\newcommand</Markup><Brace>{</Brace><UserDefinedMacro>\macro</UserDefinedMacro><Brace>}{</Brace><NormalText>Test</NormalText><UserDefinedMacroArgument>#1</UserDefinedMacroArgument><Brace>}</Brace><br/>
0032 <Section>\arguments</Section><Brace>{</Brace><br/>
0033 <NormalText>  </NormalText><Markup>\item</Markup><Brace>{</Brace><ItemName>a</ItemName><Brace>}{</Brace><Markup>\if</Markup><Brace>{</Brace><Builtin>html</Builtin><Brace>}{</Brace><NormalText>&pi; =</NormalText><Brace>}</Brace><NormalText> </NormalText><Markup>\Sexpr</Markup><Brace>[</Brace><Verbatim>stage=build</Verbatim><Brace>]{</Brace><Int>4</Int><Operator>*</Operator><Keyword>atan</Keyword><Symbol>(</Symbol><Int>1</Int><Symbol>)</Symbol><Brace>}}</Brace><br/>
0034 <NormalText>  </NormalText><Markup>\item</Markup><Brace>{</Brace><UserDefinedMacro>\dots</UserDefinedMacro><Brace>}{</Brace><UserDefinedMacro>\macro</UserDefinedMacro><Brace>{</Brace><NormalText>text</NormalText><Brace>}</Brace><NormalText> </NormalText><Markup>\link</Markup><Brace>[</Brace><Verbatim>pkg:bar</Verbatim><Brace>]{</Brace><ItemName>fooo</ItemName><Brace>}}</Brace><br/>
0035 <Brace>}</Brace><br/>
0036 <Section>\value</Section><Brace>{</Brace><br/>
0037 <NormalText>  Return a </NormalText><Markup>\code</Markup><Brace>{</Brace><Markup>\link</Markup><Brace>{</Brace><ItemName>foo</ItemName><Brace>}}</Brace><NormalText>.</NormalText><br/>
0038 <Brace>}</Brace><br/>
0039 <Section>\seealso</Section><Brace>{</Brace><br/>
0040 <NormalText>  </NormalText><Markup>\code</Markup><Brace>{</Brace><Markup>\link</Markup><Brace>{</Brace><ItemName>bar</ItemName><Brace>}}</Brace><br/>
0041 <Brace>}</Brace><br/>
0042 <Section>\examples</Section><Brace>{</Brace><br/>
0043 <Comment># R comment</Comment><br/>
0044 <Comment>% Rdoc comment</Comment><br/>
0045 <Keyword>foo</Keyword><Symbol>(</Symbol><Int>1</Int><Symbol>)</Symbol><br/>
0046 <Markup>\donttest</Markup><Brace>{</Brace><Keyword>foo</Keyword><Symbol>(</Symbol><Int>2</Int><Symbol>)</Symbol><Brace>}</Brace><br/>
0047 <Markup>\dontrun</Markup><Brace>{</Brace><Verbatim>foo(3)</Verbatim><Brace>}</Brace><br/>
0048 <Control Structure>for</Control Structure><RSource> </RSource><Symbol>(</Symbol><Normal Text>i </Normal Text><Control Structure>in</Control Structure><Normal Text> </Normal Text><Int>1</Int><Operator>:</Operator><Int>10</Int><Symbol>)</Symbol><br/>
0049 <RSource>    </RSource><Keyword>foo</Keyword><Symbol>(</Symbol><Normal Text>i</Normal Text><Symbol>)</Symbol><br/>
0050 <Brace>}</Brace><br/>
0051 <Section>\keyword</Section><Brace>{</Brace><ItemName>foo</ItemName><Brace>}</Brace><br/>