<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Free Software
Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<!-- 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>Typed Variables (GNU Texinfo 6.7)</title>
<meta name="description" content="Typed Variables (GNU Texinfo 6.7)">
<meta name="keywords" content="Typed Variables (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Def-Cmds-in-Detail.html" rel="up" title="Def Cmds in Detail">
<link href="Data-Types.html" rel="next" title="Data Types">
<link href="Typed-Functions.html" rel="prev" title="Typed Functions">
<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>
</head>
<body lang="en">
<span id="Typed-Variables"></span><div class="header">
<p>
Next: <a href="Data-Types.html" accesskey="n" rel="next">Data Types</a>, Previous: <a href="Typed-Functions.html" accesskey="p" rel="prev">Typed Functions</a>, Up: <a href="Def-Cmds-in-Detail.html" accesskey="u" rel="up">Def Cmds in Detail</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Variables-in-Typed-Languages"></span><h4 class="subsection">14.5.4 Variables in Typed Languages</h4>
<span id="index-Typed-variables"></span>
<span id="index-Variables_002c-in-typed-languages"></span>
<p>Variables in typed languages are handled in a manner similar to
functions in typed languages. See <a href="Typed-Functions.html">Typed Functions</a>. The general
definition command <code>@deftypevr</code> corresponds to
<code>@deftypefn</code> and the specialized definition command
<code>@deftypevar</code> corresponds to <code>@deftypefun</code>.
</p>
<dl compact="compact">
<dd><span id="index-deftypevr"></span>
</dd>
<dt><code>@deftypevr <var>category</var> <var>data-type</var> <var>name</var></code></dt>
<dd><p>The <code>@deftypevr</code> command is the general definition command for
something like a variable in a typed language—an entity that records
a value. You must choose a term to describe the category of the
entity being defined; for example, “Variable” could be used if the
entity is a variable.
</p>
<p>The <code>@deftypevr</code> command is written at the beginning of a line
and is followed on the same line by the category of the entity
being described, the data type, and the name of this particular
entity.
</p>
<p>For example:
</p>
<div class="example">
<pre class="example">@deftypevr {Global Flag} int enable
…
@end deftypevr
</pre></div>
<p>produces the following:
</p>
<blockquote>
<dl>
<dt id="index-enable">Global Flag: <em>int</em> <strong>enable</strong></dt>
<dd><p>…
</p></dd></dl>
</blockquote>
<p>The template is:
</p>
<div class="example">
<pre class="example">@deftypevr <var>category</var> <var>data-type</var> <var>name</var>
<var>body-of-description</var>
@end deftypevr
</pre></div>
<span id="index-deftypevar"></span>
</dd>
<dt><code>@deftypevar <var>data-type</var> <var>name</var></code></dt>
<dd><p>The <code>@deftypevar</code> command is the specialized definition command
for variables in typed languages. <code>@deftypevar</code> is equivalent
to ‘<samp>@deftypevr Variable …</samp>’. The template is:
</p>
<div class="example">
<pre class="example">@deftypevar <var>data-type</var> <var>name</var>
<var>body-of-description</var>
@end deftypevar
</pre></div>
</dd>
</dl>
<p>These commands create entries in the index of variables.
</p>
</body>
</html>