1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Format of Descriptions (GNU Octave (version 6.2.0))</title>
<meta name="description" content="Format of Descriptions (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Format of Descriptions (GNU Octave (version 6.2.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Conventions.html" rel="up" title="Conventions">
<link href="A-Sample-Function-Description.html" rel="next" title="A Sample Function Description">
<link href="Error-Messages.html" rel="prev" title="Error Messages">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<span id="Format-of-Descriptions"></span><div class="header">
<p>
Previous: <a href="Error-Messages.html" accesskey="p" rel="prev">Error Messages</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Format-of-Descriptions-1"></span><h4 class="subsection">1.3.5 Format of Descriptions</h4>
<span id="index-description-format"></span>
<p>Functions and commands are described in this manual in a uniform format.
The first line of a description contains the name of the item followed
by its arguments, if any. If there are multiple ways to invoke the
function then each allowable form is listed.
</p>
<p>The description follows on succeeding lines, sometimes with examples.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="A-Sample-Function-Description.html" accesskey="1">A Sample Function Description</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="A-Sample-Command-Description.html" accesskey="2">A Sample Command Description</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
</body>
</html>
|
