<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FAUST compiler: doc_autodoc.hh File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>doc_autodoc.hh File Reference</h1><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dynsection">
</div>
<p><a href="doc__autodoc_8hh_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc__autodoc_8hh.html#a1d778042564fea9d2d42bed09c836f13">initDocAutodoc</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatch initialization of autodoc container. <a href="#a1d778042564fea9d2d42bed09c836f13"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="doc__autodoc_8hh.html#a397f3918046c844eb8a0d69a852547c7">declareAutoDoc</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare an automatic documentation. <a href="#a397f3918046c844eb8a0d69a852547c7"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a397f3918046c844eb8a0d69a852547c7"></a><!-- doxytag: member="doc_autodoc.hh::declareAutoDoc" ref="a397f3918046c844eb8a0d69a852547c7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void declareAutoDoc </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Declare an automatic documentation. </p>
<p>This function simulates a default documentation : if no <mdoc> tag was found in the input faust file, and yet the '-math' option was called, then print a complete 'process' doc. </p>
<p>Definition at line <a class="el" href="doc__autodoc_8cpp_source.html#l00058">58</a> of file <a class="el" href="doc__autodoc_8cpp_source.html">doc_autodoc.cpp</a>.</p>
<p>References <a class="el" href="boxes_8cpp_source.html#l00056">boxIdent()</a>, <a class="el" href="list_8hh_source.html#l00124">cons()</a>, <a class="el" href="sourcereader_8cpp_source.html#l00321">declareDoc()</a>, <a class="el" href="doc_8cpp_source.html#l00184">docDgm()</a>, <a class="el" href="doc_8cpp_source.html#l00180">docEqn()</a>, <a class="el" href="doc_8cpp_source.html#l00192">docLst()</a>, <a class="el" href="doc_8cpp_source.html#l00188">docNtc()</a>, <a class="el" href="doc_8cpp_source.html#l00166">docTxt()</a>, <a class="el" href="doc__autodoc_8cpp_source.html#l00037">gDocAutodocStringMap</a>, <a class="el" href="sourcereader_8cpp_source.html#l00251">SourceReader::listSrcFiles()</a>, and <a class="el" href="list_8cpp_source.html#l00116">nil</a>.</p>
<p>Referenced by <a class="el" href="doc_8cpp_source.html#l00216">printDoc()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00059"></a>00059 {
<a name="l00060"></a>00060 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> autodoc = <a class="code" href="list_8cpp.html#a538b704dd07794b7237108f1917c471e">nil</a>;
<a name="l00061"></a>00061 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> process = <a class="code" href="boxes_8cpp.html#ab32253e24dd40d91b770b381da0d35b1">boxIdent</a>(<span class="stringliteral">"process"</span>);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keywordtype">string</span> autoEquationTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autoeqntitle"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00064"></a>00064 autoEquationTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autoeqntext"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00065"></a>00065 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a>(autoEquationTxt.c_str()), autodoc);
<a name="l00066"></a>00066 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a74f8c842c37fd8d9e01b397d79abe117">docEqn</a>(process), autodoc);
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keywordtype">string</span> autoDiagramTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autodgmtitle"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00069"></a>00069 autoDiagramTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autodgmtext"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00070"></a>00070 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a>(autoDiagramTxt.c_str()), autodoc);
<a name="l00071"></a>00071 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#aa454efefb0dc22ade70352eee0fdb9ff">docDgm</a>(process), autodoc);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keywordtype">string</span> autoNoticeTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autontctitle"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00074"></a>00074 autoNoticeTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autontctext"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00075"></a>00075 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a>(autoNoticeTxt.c_str()), autodoc);
<a name="l00076"></a>00076 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a8d813459bc7fcb5ceba9c07ca205d1f1">docNtc</a>(), autodoc);
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keywordtype">string</span> autoListingTxt;
<a name="l00079"></a>00079 vector<string> pathnames = <a class="code" href="doc_8cpp.html#af59bae68e0652dd8c1ecbf661cbe8373">gReader</a>.<a class="code" href="classSourceReader.html#a02d4fe696337e6e327b14620ed76b626" title="Return a vector of pathnames representing the list of all the source files that have...">listSrcFiles</a>();
<a name="l00080"></a>00080 <span class="keywordflow">if</span>(pathnames.size() > 1) {
<a name="l00081"></a>00081 autoListingTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autolsttitle2"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00082"></a>00082 autoListingTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autolsttext2"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00083"></a>00083 } <span class="keywordflow">else</span> {
<a name="l00084"></a>00084 autoListingTxt = <span class="stringliteral">"\n"</span> + <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autolsttitle1"</span>] + <span class="stringliteral">"\n\n"</span>;
<a name="l00085"></a>00085 autoListingTxt += <a class="code" href="doc__autodoc_8cpp.html#af7ce9ec8a5ae61a52f3b4910397e0310">gDocAutodocStringMap</a>[<span class="stringliteral">"autolsttext1"</span>] + <span class="stringliteral">"\n"</span>;
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a>(autoListingTxt.c_str()), autodoc);
<a name="l00088"></a>00088 autodoc = <a class="code" href="list_8hh.html#ae1ed153946fcfc025009c6d9c9c40bee">cons</a>(<a class="code" href="doc_8cpp.html#a6710f31a71806f69ac8cf5c7933c4fa6">docLst</a>(), autodoc);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <a class="code" href="sourcereader_8cpp.html#a7cd651735195e5651ebee01a3f6e914c">declareDoc</a>(autodoc);
<a name="l00091"></a>00091 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
<a class="anchor" id="a1d778042564fea9d2d42bed09c836f13"></a><!-- doxytag: member="doc_autodoc.hh::initDocAutodoc" ref="a1d778042564fea9d2d42bed09c836f13" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void initDocAutodoc </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dispatch initialization of autodoc container. </p>
<p>Definition at line <a class="el" href="doc__autodoc_8cpp_source.html#l00097">97</a> of file <a class="el" href="doc__autodoc_8cpp_source.html">doc_autodoc.cpp</a>.</p>
<p>References <a class="el" href="doc__autodoc_8cpp_source.html#l00112">initDocAutodocKeySet()</a>.</p>
<p>Referenced by <a class="el" href="doc__lang_8cpp_source.html#l00076">loadTranslationFile()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <a class="code" href="doc__autodoc_8cpp.html#acaa5fea9d875d26a82c92910ff3b14f2" title="Initialize gDocAutodocKeySet, a set containing all the keywords.">initDocAutodocKeySet</a>();
<a name="l00100"></a>00100 }
</pre></div></p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
</div>
</p>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Apr 29 00:00:04 2010 for FAUST compiler by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
