<!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.hh Source File</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>
<h1>doc.hh</h1><a href="doc_8hh.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef _DOC_</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define _DOC_</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="comment">/************************************************************************</span>
<a name="l00005"></a>00005 <span class="comment"> ************************************************************************</span>
<a name="l00006"></a>00006 <span class="comment"> FAUST compiler</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2003-2004 GRAME, Centre National de Creation Musicale</span>
<a name="l00008"></a>00008 <span class="comment"> ---------------------------------------------------------------------</span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00017"></a>00017 <span class="comment"> GNU General Public License for more details.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00020"></a>00020 <span class="comment"> along with this program; if not, write to the Free Software</span>
<a name="l00021"></a>00021 <span class="comment"> Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00022"></a>00022 <span class="comment"> ************************************************************************</span>
<a name="l00023"></a>00023 <span class="comment"> ************************************************************************/</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="comment">/*****************************************************************************</span>
<a name="l00028"></a>00028 <span class="comment">******************************************************************************</span>
<a name="l00029"></a>00029 <span class="comment"> FAUST DOCUMENTATOR</span>
<a name="l00030"></a>00030 <span class="comment"> K. Barkati & Y. Orlarey, (c) Grame 2009</span>
<a name="l00031"></a>00031 <span class="comment">------------------------------------------------------------------------------</span>
<a name="l00032"></a>00032 <span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment"> History :</span>
<a name="l00034"></a>00034 <span class="comment"> ---------</span>
<a name="l00035"></a>00035 <span class="comment"> 2009-07-19 : First version</span>
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">******************************************************************************</span>
<a name="l00038"></a>00038 <span class="comment">*****************************************************************************/</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="tlib_8hh.html">tlib.hh</a>"</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="eval_8hh.html" title="Interface of the block diagram evaluator.">eval.hh</a>"</span>
<a name="l00042"></a>00042 <span class="comment">//#include "signals.hh"</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">//struct Automaton;</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">/*****************************************************************************</span>
<a name="l00049"></a>00049 <span class="comment">******************************************************************************</span>
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> The Documentator</span>
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment">******************************************************************************</span>
<a name="l00054"></a>00054 <span class="comment">*****************************************************************************/</span>
<a name="l00055"></a>00055
<a name="l00056"></a>00056
<a name="l00057"></a>00057
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">/*****************************************************************************</span>
<a name="l00060"></a>00060 <span class="comment"> Doc Types Creation & Test</span>
<a name="l00061"></a>00061 <span class="comment">*****************************************************************************/</span>
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <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> <a class="code" href="doc_8cpp.html#a3ef69c2f85a3c6ae95968d7563b4aff2">docTxt</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>*);
<a name="l00064"></a>00064 <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> <a class="code" href="doc_8cpp.html#a74f8c842c37fd8d9e01b397d79abe117">docEqn</a> (<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> x);
<a name="l00065"></a>00065 <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> <a class="code" href="doc_8cpp.html#aa454efefb0dc22ade70352eee0fdb9ff">docDgm</a> (<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> x);
<a name="l00066"></a>00066 <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> <a class="code" href="doc_8cpp.html#a8d813459bc7fcb5ceba9c07ca205d1f1">docNtc</a> ();
<a name="l00067"></a>00067 <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> <a class="code" href="doc_8cpp.html#a6710f31a71806f69ac8cf5c7933c4fa6">docLst</a> ();
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keywordtype">bool</span> <a class="code" href="doc_8cpp.html#ad0b394e474b1e452e44de4b7e7dbb106">isDocTxt</a> (<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> t);
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> <a class="code" href="doc_8cpp.html#ad0b394e474b1e452e44de4b7e7dbb106">isDocTxt</a> (<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> t, <span class="keyword">const</span> <span class="keywordtype">char</span>**);
<a name="l00071"></a>00071 <span class="keywordtype">bool</span> <a class="code" href="doc_8cpp.html#a8f5e00372043167fc1d7fe12532a020e">isDocEqn</a> (<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> t, <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>& x);
<a name="l00072"></a>00072 <span class="keywordtype">bool</span> <a class="code" href="doc_8cpp.html#adb0333bf59f0c1891e28e6b21b3060a1">isDocDgm</a> (<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> t, <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>& x);
<a name="l00073"></a>00073 <span class="keywordtype">bool</span> <a class="code" href="doc_8cpp.html#ac6cfa5258d1a4a0c52d636615be62a50">isDocNtc</a> (<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> t);
<a name="l00074"></a>00074 <span class="keywordtype">bool</span> <a class="code" href="doc_8cpp.html#ae3a40683ffbfc5c9a8af59be69241d40">isDocLst</a> (<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> t);
<a name="l00075"></a>00075
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">/*****************************************************************************</span>
<a name="l00078"></a>00078 <span class="comment"> Printing Public Function</span>
<a name="l00079"></a>00079 <span class="comment">*****************************************************************************/</span>
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keywordtype">void</span> <a class="code" href="doc_8cpp.html#a8c5b3a35aaf051de7ed2a8e480a010f4" title="The entry point to generate faust doc files.">printDoc</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* projname, <span class="keyword">const</span> <span class="keywordtype">char</span>* docdev, <span class="keyword">const</span> <span class="keywordtype">char</span>* faustversion);
<a name="l00082"></a>00082
<a name="l00083"></a>00083
<a name="l00084"></a>00084
<a name="l00085"></a>00085
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Apr 28 23:59:58 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>
