<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- Reference Manual DTDs</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/erl_docgen-0.3.3.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>Erl_Docgen</strong><br><strong>User's Guide</strong><br><small>Version 0.3.3</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Chapters</strong></small></p>
<ul class="flipMenu" imagepath="../../../../doc/js/flipmenu">
<li id="no" title="How to Build OTP like documentation" expanded="false">How to Build OTP like documentation<ul>
<li><a href="doc-build.html">
Top of chapter
</a></li>
<li title="Utilities to prepare XML files"><a href="doc-build.html#id63368">Utilities to prepare XML files</a></li>
<li title="Use xsltproc to generate different output formats"><a href="doc-build.html#id61175">Use xsltproc to generate different output formats</a></li>
</ul>
</li>
<li id="no" title="Overview OTP DTDs" expanded="false">Overview OTP DTDs<ul>
<li><a href="overview.html">
Top of chapter
</a></li>
<li title="DTD Suite"><a href="overview.html#id64762">DTD Suite</a></li>
<li title="Basic Tags"><a href="overview.html#id68138">Basic Tags</a></li>
</ul>
</li>
<li id="no" title="User's Guide DTDs" expanded="false">User's Guide DTDs<ul>
<li><a href="user_guide_dtds.html">
Top of chapter
</a></li>
<li title="The part DTD"><a href="user_guide_dtds.html#id60222">The part DTD</a></li>
<li title="<part>"><a href="user_guide_dtds.html#id60510"><part></a></li>
<li title="<description>"><a href="user_guide_dtds.html#id68097"><description></a></li>
<li title="<include>"><a href="user_guide_dtds.html#id60627"><include></a></li>
<li title="The chapter DTD"><a href="user_guide_dtds.html#id68049">The chapter DTD</a></li>
<li title="<chapter>"><a href="user_guide_dtds.html#id63655"><chapter></a></li>
<li title="<section>"><a href="user_guide_dtds.html#id62101"><section></a></li>
<li title="<title>"><a href="user_guide_dtds.html#id62142"><title></a></li>
</ul>
</li>
<li id="loadscrollpos" title="Reference Manual DTDs" expanded="true">Reference Manual DTDs<ul>
<li><a href="refman_dtds.html">
Top of chapter
</a></li>
<li title="The application DTD"><a href="refman_dtds.html#id64613">The application DTD</a></li>
<li title="<application>"><a href="refman_dtds.html#id64497"><application></a></li>
<li title="The appref DTD"><a href="refman_dtds.html#id67949">The appref DTD</a></li>
<li title="The comref DTD"><a href="refman_dtds.html#id63005">The comref DTD</a></li>
<li title="The cref DTD"><a href="refman_dtds.html#id65218">The cref DTD</a></li>
<li title="The erlref DTD"><a href="refman_dtds.html#id65347">The erlref DTD</a></li>
<li title="The fileref DTD"><a href="refman_dtds.html#id65477">The fileref DTD</a></li>
<li title="<description>"><a href="refman_dtds.html#id65618"><description></a></li>
<li title="<section>"><a href="refman_dtds.html#id65651"><section></a></li>
<li title="<funcs>"><a href="refman_dtds.html#id65692"><funcs></a></li>
<li title="<func>"><a href="refman_dtds.html#id65718"><func></a></li>
<li title="<name>"><a href="refman_dtds.html#id65761"><name></a></li>
<li title="<fsummary>"><a href="refman_dtds.html#id65831"><fsummary></a></li>
<li title="<type>"><a href="refman_dtds.html#id65859"><type></a></li>
<li title="<v>"><a href="refman_dtds.html#id65891"><v></a></li>
<li title="<d>"><a href="refman_dtds.html#id65907"><d></a></li>
<li title="<desc>"><a href="refman_dtds.html#id65934"><desc></a></li>
<li title="<authors>"><a href="refman_dtds.html#id65964"><authors></a></li>
<li title="<aname>"><a href="refman_dtds.html#id66000"><aname></a></li>
<li title="<email>"><a href="refman_dtds.html#id66016"><email></a></li>
</ul>
</li>
<li id="no" title="Header Tags" expanded="false">Header Tags<ul>
<li><a href="header_tags.html">
Top of chapter
</a></li>
<li title="<header>"><a href="header_tags.html#id66099"><header></a></li>
<li title="<copyright>"><a href="header_tags.html#id66115"><copyright></a></li>
<li title="<legalnotice>"><a href="header_tags.html#id66159"><legalnotice></a></li>
<li title="<title>"><a href="header_tags.html#id66188"><title></a></li>
<li title="<shorttitle>"><a href="header_tags.html#id66219"><shorttitle></a></li>
<li title="<prepared>"><a href="header_tags.html#id66234"><prepared></a></li>
<li title="<responsible>"><a href="header_tags.html#id66250"><responsible></a></li>
<li title="<docno>"><a href="header_tags.html#id66266"><docno></a></li>
<li title="<approved>"><a href="header_tags.html#id66297"><approved></a></li>
<li title="<checked>"><a href="header_tags.html#id66313"><checked></a></li>
<li title="<date>"><a href="header_tags.html#id66328"><date></a></li>
<li title="<rev>"><a href="header_tags.html#id66344"><rev></a></li>
<li title="<file>"><a href="header_tags.html#id66376"><file></a></li>
</ul>
</li>
<li id="no" title="Block Tags" expanded="false">Block Tags<ul>
<li><a href="block_tags.html">
Top of chapter
</a></li>
<li title="<br> - Line Break"><a href="block_tags.html#id66498"><br> - Line Break</a></li>
<li title="<code> - Code Example"><a href="block_tags.html#id66536"><code> - Code Example</a></li>
<li title="<codeinclude> - Code Inclusion"><a href="block_tags.html#id66589"><codeinclude> - Code Inclusion</a></li>
<li title="<erleval> - Erlang Evaluation"><a href="block_tags.html#id66663"><erleval> - Erlang Evaluation</a></li>
<li title="<list> - List"><a href="block_tags.html#id66698"><list> - List</a></li>
<li title="<marker> - Marker"><a href="block_tags.html#id66782"><marker> - Marker</a></li>
<li title="<p> - Paragraph"><a href="block_tags.html#id66808"><p> - Paragraph</a></li>
<li title="<note> - Note"><a href="block_tags.html#id66849"><note> - Note</a></li>
<li title="<pre> - Pre-formatted Text"><a href="block_tags.html#id66895"><pre> - Pre-formatted Text</a></li>
<li title="<quote> - Quotation"><a href="block_tags.html#id66970"><quote> - Quotation</a></li>
<li title="<taglist> - Definition List"><a href="block_tags.html#id67018"><taglist> - Definition List</a></li>
<li title="<warning> - Warning"><a href="block_tags.html#id67121"><warning> - Warning</a></li>
<li title="<image> - Image"><a href="block_tags.html#id67173"><image> - Image</a></li>
<li title="<table> - Table"><a href="block_tags.html#id67236"><table> - Table</a></li>
</ul>
</li>
<li id="no" title="Inline Tags" expanded="false">Inline Tags<ul>
<li><a href="inline_tags.html">
Top of chapter
</a></li>
<li title="<br> - Line Break"><a href="inline_tags.html#id67434"><br> - Line Break</a></li>
<li title="<c> - Code"><a href="inline_tags.html#id67460"><c> - Code</a></li>
<li title="<em> - Emphasis"><a href="inline_tags.html#id67508"><em> - Emphasis</a></li>
<li title="<marker> - Marker"><a href="inline_tags.html#id67549"><marker> - Marker</a></li>
<li title="<seealso> - Local Cross Reference"><a href="inline_tags.html#id67607"><seealso> - Local Cross Reference</a></li>
<li title="<url> - Non-Local Cross Reference"><a href="inline_tags.html#id67687"><url> - Non-Local Cross Reference</a></li>
<li title="<term>, <termdef> - Glossary"><a href="inline_tags.html#id67726"><term>, <termdef> - Glossary</a></li>
<li title="<cite>, <citedef> - Bibliography"><a href="inline_tags.html#id67790"><cite>, <citedef> - Bibliography</a></li>
</ul>
</li>
<li id="no" title="Character Entities" expanded="false">Character Entities<ul>
<li><a href="character_entities.html">
Top of chapter
</a></li>
<li title="Added Latin 1"><a href="character_entities.html#id67860">Added Latin 1</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<h1>4 Reference Manual DTDs</h1>
<p>There are five DTDs for writing manual pages about applications,
shell commands, C libraries, Erlang modules and files, all with a
similar structure:</p>
<ul>
<li>A header.</li>
<li>Name of the application/command/library/module/file.</li>
<li>Short summary (one line).</li>
<li>A longer description.</li>
<li>"Formal" definitions of functions or commands.</li>
<li>Optional sections of free text.</li>
<li>Optional section with the name(s) and email(s) of the author(s).</li>
</ul>
<p>The differences between the DTDs are the tags for the name,
the short summary and some tags inside the "formal" definitions.</p>
<h3><a name="id64613">4.1
The application DTD</a></h3>
<a name="applicationDTD"></a>
<p>The <span class="code">application</span> DTD is intended for a Reference Manual and
groups a set of manual pages into one unit. The structure is
similar to the part DTD: first an introduction and then the manual
pages, written in separate files with the
<span class="bold_code"><a href="#apprefDTD">appref</a></span>,
<span class="bold_code"><a href="#comrefDTD">comref</a></span>,
<span class="bold_code"><a href="#crefDTD">cref</a></span>,
<span class="bold_code"><a href="#erlrefDTD">erlref</a></span>, or
<span class="bold_code"><a href="#filerefDTD">fileref</a></span> DTD.</p>
<p>Example:</p>
<div class="example"><pre>
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE application SYSTEM "application.dtd">
<application>
<header>
<title>Application name</title>
<prepared/>
<docno/>
<date/>
<rev/>
</header>
<description>
<p>Application description...</p>
</description>
<include file="module1">
<include file="module2">
</application>
</pre></div>
<h3><a name="id64497">4.2
<application></a></h3>
<a name="applicationTAG"></a>
<p>The top level tag of an <span class="code">application</span> DTD.</p>
<p>Contains a
<span class="bold_code"><a href="header_tags.html"><header></a></span>,
an optional
<span class="bold_code"><a href="user_guide_dtds.html#descriptionTAG"><description></a></span>,
followed by one or more
<span class="bold_code"><a href="user_guide_dtds.html#includeTAG"><include></a></span>.
</p>
<h3><a name="id67949">4.3
The appref DTD</a></h3>
<a name="apprefDTD"></a>
<p>This is the DTD for writing an application manual page.</p>
<p>Example:</p>
<div class="example"><pre>
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE appref SYSTEM "appref.dtd">
<appref>
<header>
<title>Application name</title>
<prepared/>
<docno/>
<date/>
<rev/>
</header>
<app>Application name</app>
<appsummary>A short application summary.</appsummary>
<description>
<p>A longer description of the application.</p>
</description>
<section>
<title>Configuration</title>
<p>...</p>
</section>
...
<authors>
<aname>Name of author</aname>
<email>Email of author</email>
</authors>
</appref>
</pre></div>
<h4><appref></h4>
<a name="apprefTAG"></a>
<p>The top level tag of an <span class="code">appref</span> DTD.</p>
<p>Contains
<span class="bold_code"><a href="header_tags.html#headerTAG"><header></a></span>,
<span class="bold_code"><a href="#appTAG"><app></a></span>,
<span class="bold_code"><a href="#appsummaryTAG"><appsummary></a></span>,
<span class="bold_code"><a href="#descriptionTAG"><description></a></span>,
zero or more
<span class="bold_code"><a href="#sectionTAG"><section></a></span> and
<span class="bold_code"><a href="#funcsTAG"><funcs></a></span>,
followed by zero or more
<span class="bold_code"><a href="#authorsTAG"><authors></a></span>.</p>
<h4><app></h4>
<a name="appTAG"></a>
<p>The application name. Contains plain text.</p>
<h4><appsummary></h4>
<a name="appsummaryTAG"></a>
<p>Short summary. Contains plain text.</p>
<h3><a name="id63005">4.4
The comref DTD</a></h3>
<a name="comrefDTD"></a>
<p>This is the DTD for writing a command manual page.</p>
<p>Example:</p>
<div class="example"><pre>
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE comref SYSTEM "comref.dtd">
<comref>
<header>
<title>Command name</title>
<prepared/>
<docno/>
<date/>
<rev/>
</header>
<com>Command name</com>
<comsummary>A short command summary.</comsummary>
<description>
<p>A long description of the command.</p>
</description>
<funcs>
<func>
<name>command</name>
<name>command -flag <arg></name>
<fsummary>A short command summary (max 40 characters).</fsummary>
<desc>
<p>An extended command description.
</desc>
</func>
</funcs>
<section>
<title>Options</title>
<p>...</p>
</section>
<authors>
<aname>Name of author</aname>
<email>Email of author</email>
</authors>
</comref>
</pre></div>
<h4><comref></h4>
<a name="comrefTAG"></a>
<p>The top level tag for a <span class="code">comref</span> DTD.</p>
<p>Contains
<span class="bold_code"><a href="header_tags.html#headerTAG"><header></a></span>,
<span class="bold_code"><a href="#comTAG"><com></a></span>,
<span class="bold_code"><a href="#comsummaryTAG"><comsummary></a></span>,
<span class="bold_code"><a href="#descriptionTAG"><description></a></span>,
zero or more
<span class="bold_code"><a href="#sectionTAG"><section></a></span> and
<span class="bold_code"><a href="#funcsTAG"><funcs></a></span>,
followed by zero or more
<span class="bold_code"><a href="#authorsTAG"><authors></a></span>.</p>
<h4><com></h4>
<a name="comTAG"></a>
<p>The command name. Contains plain text.</p>
<h4><comsummary></h4>
<a name="comsummaryTAG"></a>
<p>Short summary. Contains plain text.</p>
<h3><a name="id65218">4.5
The cref DTD</a></h3>
<a name="crefDTD"></a>
<p>This is the DTD for writing a C library manual page.</p>
<p>Example:</p>
<div class="example"><pre>
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE cref SYSTEM "cref.dtd">
<cref>
<header>
<title>C library name</title>
<prepared/>
<docno/>
<date/>
<rev/>
</header>
<lib>C library name</lib>
<libsummary>A short C library summary.</libsummary>
<description>
<p>A longer description of the C library.</p>
</description>
<funcs>
<func>
<name><ret>void</ret><nametext>start(bar)</nametext></name>
<name><ret>void</ret><nametext>start(foo)</nametext></name>
<fsummary>A short function summary (max 40 characters).</fsummary>
<type>
<v>char bar</v>
<v>int foo</v>
</type>
<desc>
<p>An extended function description.</p>
</desc>
</func>
...
</funcs>
<section>
<title>A title</title>
<p>Some text...</p>
</section>
</cref>
</pre></div>
<h4><cref></h4>
<a name="crefTAG"></a>
<p>The top level tag for a <span class="code">cref</span> DTD.</p>
<p>Contains
<span class="bold_code"><a href="header_tags.html#headerTAG"><header></a></span>,
<span class="bold_code"><a href="#libTAG"><lib></a></span>,
<span class="bold_code"><a href="#libsummaryTAG"><libsummary></a></span>,
<span class="bold_code"><a href="#descriptionTAG"><description></a></span>,
zero or more
<span class="bold_code"><a href="#sectionTAG"><section></a></span> and
<span class="bold_code"><a href="#funcsTAG"><funcs></a></span>, followed by
zero or more
<span class="bold_code"><a href="#authorsTAG"><authors></a></span>.</p>
<h4><lib></h4>
<a name="libTAG"></a>
<p>The C library name or acronym. Contains plain text.</p>
<h4><libsummary></h4>
<a name="libsummaryTAG"></a>
<p>Short summary. Contains plain text.</p>
<h3><a name="id65347">4.6
The erlref DTD</a></h3>
<a name="erlrefDTD"></a>
<p>This is the DTD for writing Erlang module manual pages.</p>
<p>Example:</p>
<div class="example"><pre>
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<title>Module name</title>
<prepared/>
<docno/>
<date/>
<rev/>
</header>
<module>Module name</module>
<modulesummary>A short module summary.</modulesummary>
<description>
<p>A longer description of the module.</p>
</description>
<funcs>
<func>
<name>start() -> Result</name>
<name>start(N) -> Result</name>
<fsummary>A short function summary (max 40 characters).</fsummary>
<type>
<v>Pid = pid()</v>
<v>N = int()</v>
<v>Result = {ok, Pid} | {error, Reason}</v>
<v>Reason = term()</v>
<d>A parameter description.</d>
</type>
<desc>
<p>An extended function description.</p>
</desc>
</func>
...
</funcs>
<section>
<title>Some Title</title>
<p>Some text...</p>
</section>
<authors>
<aname>Name of author</aname>
<email>Email of author</email>
</authors>
</erlref>
</pre></div>
<h4><erlref></h4>
<a name="erlrefTAG"></a>
<p>The top level tag for an <span class="code">erlref</span> DTD.</p>
<p>Contains
<span class="bold_code"><a href="header_tags.html#headerTAG"><header></a></span>,
<span class="bold_code"><a href="#moduleTAG"><module></a></span>,
<span class="bold_code"><a href="#modulesummaryTAG"><modulesummary></a></span>,
<span class="bold_code"><a href="#descriptionTAG"><description></a></span>,
zero or more
<span class="bold_code"><a href="#sectionTAG"><section></a></span> and
<span class="bold_code"><a href="#funcsTAG"><funcs></a></span>,
followed by zero or more
<span class="bold_code"><a href="#authorsTAG"><authors></a></span>.</p>
<h4><module></h4>
<a name="moduleTAG"></a>
<p>The module name. Contains plain text.</p>
<h4><modulesummary></h4>
<a name="modulesummaryTAG"></a>
<p>Short summary. Contains plain text.</p>
<h3><a name="id65477">4.7
The fileref DTD</a></h3>
<a name="filerefDTD"></a>
<p>This is the DTD for writing file manual pages. In OTP, this DTD
is used for defining the format of for example <span class="code">.rel</span> and
<span class="code">.app</span> files.</p>
<p>Example:</p>
<div class="example"><pre>
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE fileref SYSTEM "fileref.dtd">
<fileref>
<header>
<title>File name</title>
<prepared/>
<docno/>
<date/>
<rev/>
</header>
<file>fileref</file>
<filesummary>A short file summary.</filesummary>
<description>
<p>A longer description of the file.</p>
</description>
<section>
<title>File format</title>
<p>...</p>
</section>
<authors>
<aname>Name of author</aname>
<email>Email of author</email>
</authors>
</fileref>
</pre></div>
<p>The file reference manual can also contain function definitions,
similar to the <span class="code">erlref</span> DTD.</p>
<h4><fileref></h4>
<a name="filerefTAG"></a>
<p>The top level tag for a <span class="code">fileref</span> DTD.</p>
<p>Contains
<span class="bold_code"><a href="header_tags.html#headerTAG"><header></a></span>,
<span class="bold_code"><a href="#fileTAG"><file></a></span>,
<span class="bold_code"><a href="#filesummaryTAG"><filesummary></a></span>,
<span class="bold_code"><a href="#descriptionTAG"><description></a></span>,
zero or more
<span class="bold_code"><a href="#sectionTAG"><section></a></span> and
<span class="bold_code"><a href="#funcsTAG"><funcs></a></span>,
followed by zero or more
<span class="bold_code"><a href="#authorsTAG"><authors></a></span>.</p>
<h4><file></h4>
<a name="fileTAG"></a>
<p>The name of the file or file type. Contains plain text.</p>
<h4><filesummary></h4>
<a name="filesummaryTAG"></a>
<p>Short summary. Contains plain text.</p>
<h3><a name="id65618">4.8
<description></a></h3>
<a name="descriptionTAG"></a>
<p>The introduction after the title and before sections and
"formal" definitions.</p>
<p>Contains any combination and any number of
<span class="bold_code"><a href="block_tags.html">block tags</a></span> except
<span class="code"><image></span> and <span class="code"><table></span>.</p>
<h3><a name="id65651">4.9
<section></a></h3>
<a name="sectionTAG"></a>
<p>Subdivisions of the document. Contains an optional
<span class="bold_code"><a href="inline_tags.html#markerTAG"><marker></a></span>,
a <span class="bold_code"><a href="user_guide_dtds.html#titleTAG"><title></a></span>,
followed by any combination and any number of
<span class="bold_code"><a href="block_tags.html">block tags</a></span> except
<span class="code"><image></span> and <span class="code"><table></span>.</p>
<h3><a name="id65692">4.10
<funcs></a></h3>
<a name="funcsTAG"></a>
<p>A group of "formal" function definitions.</p>
<p>Contains one or more
<span class="bold_code"><a href="#funcTAG"><func></a></span>.</p>
<h3><a name="id65718">4.11
<func></a></h3>
<a name="funcTAG"></a>
<p>A "formal" function definition.</p>
<p>Contains one or more
<span class="bold_code"><a href="#nameTAG"><name></a></span>, followed by
<span class="bold_code"><a href="#fsummaryTAG"><fsummary></a></span>,
<span class="bold_code"><a href="#typeTAG"><type></a></span> (optional) and
<span class="bold_code"><a href="#descTAG"><desc></a></span> (optional).</p>
<h3><a name="id65761">4.12
<name></a></h3>
<a name="nameTAG"></a>
<p>Function/command signature with name, arguments and return value.
Contains plain text, except for the <span class="code">cref</span> DTD where it
contains a <span class="code"><ret></span> (return type, plain text) and
a <span class="code"><nametext></span> (function name and arguments,
plain text).</p>
<p>In the case of an <span class="code">erlref</span> DTD, it will
automatically be added a
<span class="bold_code"><a href="inline_tags.html#markerTAG">marker</a></span>,
<span class="code"><marker id="Name/Arity"></span> or
<span class="code"><marker id="Name"></span>, based on the contents of
this tag before the function definition.</p>
<p>Example: Consider the following name definition</p>
<div class="example"><pre>
<name>foo(Arg1, Arg2) -> ok | {error, Reason}</name>
</pre></div>
<p>Then a marker like this will be added
<span class="code"><marker id="foo/2"></span> before the function
definition in the generated HTML. That is, referring to
the function using
<span class="code"><seealso marker="#foo/2">foo/2</seealso></span> will
automatically work.</p>
<h3><a name="id65831">4.13
<fsummary></a></h3>
<a name="fsummaryTAG"></a>
<p>Function/command summary. Contains plain text,
<span class="bold_code"><a href="inline_tags.html#cTAG"><c></a></span> and
<span class="bold_code"><a href="inline_tags.html#emTAG"><em></a></span>.</p>
<h3><a name="id65859">4.14
<type></a></h3>
<a name="typeTAG"></a>
<p>Type declarations for the function/command.</p>
<p>Contains one or more pairs of
<span class="bold_code"><a href="#vTAG"><v></a></span> and
<span class="bold_code"><a href="#dTAG"><d></a></span> (optional).</p>
<h3><a name="id65891">4.15
<v></a></h3>
<a name="vTAG"></a>
<p>Type declaration for an argument or return value. Contains plain
text.</p>
<h3><a name="id65907">4.16
<d></a></h3>
<a name="dTAG"></a>
<p>Description for an argument or return value. Contains plain text,
<span class="bold_code"><a href="inline_tags.html#cTAG"><c></a></span> and
<span class="bold_code"><a href="inline_tags.html#emTAG"><em></a></span>.</p>
<h3><a name="id65934">4.17
<desc></a></h3>
<a name="descTAG"></a>
<p>Function/command description. Contains
<span class="bold_code"><a href="block_tags.html">block tags</a></span> except
<span class="code"><image></span> and <span class="code"><table></span>.</p>
<h3><a name="id65964">4.18
<authors></a></h3>
<a name="authorsTAG"></a>
<p>Authors of the manual page. The <span class="code">authors</span> element is optional.</p>
<p>Contains one or more pairs of
<span class="bold_code"><a href="#anameTAG"><aname></a></span> and
<span class="bold_code"><a href="#emailTAG"><email></a></span>.</p>
<h3><a name="id66000">4.19
<aname></a></h3>
<a name="anameTAG"></a>
<p>Author name. Contains plain text.</p>
<h3><a name="id66016">4.20
<email></a></h3>
<a name="emailTAG"></a>
<p>Author email address. Contains plain text.</p>
</div>
<div class="footer">
<hr>
<p>Copyright © 2004-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
675c8c8167236dfcf8d66da674f931e8
>
files
>
579
