doc_autodoc.hh File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void initDocAutodoc ()
 Dispatch initialization of autodoc container.
void declareAutoDoc ()
 Declare an automatic documentation.

Function Documentation

void declareAutoDoc (  ) 

Declare an automatic documentation.

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.

Definition at line 58 of file doc_autodoc.cpp.

References boxIdent(), cons(), declareDoc(), docDgm(), docEqn(), docLst(), docNtc(), docTxt(), gDocAutodocStringMap, SourceReader::listSrcFiles(), and nil.

Referenced by printDoc().

00059 {
00060     Tree autodoc = nil;
00061     Tree process = boxIdent("process");
00062     
00063     string autoEquationTxt = "\n" + gDocAutodocStringMap["autoeqntitle"] + "\n\n";
00064     autoEquationTxt += gDocAutodocStringMap["autoeqntext"] + "\n";
00065     autodoc = cons(docTxt(autoEquationTxt.c_str()), autodoc);
00066     autodoc = cons(docEqn(process), autodoc);
00067     
00068     string autoDiagramTxt = "\n" + gDocAutodocStringMap["autodgmtitle"] + "\n\n";
00069     autoDiagramTxt += gDocAutodocStringMap["autodgmtext"] + "\n";
00070     autodoc = cons(docTxt(autoDiagramTxt.c_str()), autodoc);
00071     autodoc = cons(docDgm(process), autodoc);   
00072     
00073     string autoNoticeTxt = "\n" + gDocAutodocStringMap["autontctitle"] + "\n\n";
00074     autoNoticeTxt += gDocAutodocStringMap["autontctext"] + "\n";
00075     autodoc = cons(docTxt(autoNoticeTxt.c_str()), autodoc);
00076     autodoc = cons(docNtc(), autodoc);
00077     
00078     string autoListingTxt;
00079     vector<string> pathnames = gReader.listSrcFiles();
00080     if(pathnames.size() > 1) {
00081         autoListingTxt = "\n" + gDocAutodocStringMap["autolsttitle2"] + "\n\n";
00082         autoListingTxt += gDocAutodocStringMap["autolsttext2"] + "\n";
00083     } else {
00084         autoListingTxt = "\n" + gDocAutodocStringMap["autolsttitle1"] + "\n\n";
00085         autoListingTxt += gDocAutodocStringMap["autolsttext1"] + "\n";
00086     }
00087     autodoc = cons(docTxt(autoListingTxt.c_str()), autodoc);
00088     autodoc = cons(docLst(), autodoc);
00089     
00090     declareDoc(autodoc);
00091 }

Here is the call graph for this function:

Here is the caller graph for this function:

void initDocAutodoc (  ) 

Dispatch initialization of autodoc container.

Definition at line 97 of file doc_autodoc.cpp.

References initDocAutodocKeySet().

Referenced by loadTranslationFile().

00098 {
00099     initDocAutodocKeySet();
00100 }

Here is the call graph for this function:

Here is the caller graph for this function:

Generated on Thu Apr 29 00:00:04 2010 for FAUST compiler by  doxygen 1.6.3