ALICE FMD Off-line: scripts/Document.C Source File

00001 /**************************************************************************
00002  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
00003  *                                                                        *
00004  * Author: The ALICE Off-line Project.                                    *
00005  * Contributors are mentioned in the code where appropriate.              *
00006  *                                                                        *
00007  * Permission to use, copy, modify and distribute this software and its   *
00008  * documentation strictly for non-commercial purposes is hereby granted   *
00009  * without fee, provided that the above copyright notice appears in all   *
00010  * copies and that both the copyright notice and this permission notice   *
00011  * appear in the supporting documentation. The authors make no claims     *
00012  * about the suitability of this software for any purpose. It is          *
00013  * provided "as is" without express or implied warranty.                  *
00014  **************************************************************************/
00015 
00016 /* $Id: Document.C,v 1.1 2004/11/23 09:08:34 cholm Exp $ */
00017 
00018 // Script to document the FMD code
00021 void
00022 Document()
00023 {
00024   gEnv->SetValue("Root.Html.SourceDir", "$(ALICE)/FMD");
00025   gEnv->SetValue("Root.Html.OutputDir", "$(ALICE)/FMD/html");
00026 
00027   gSystem->MakeDirectory("$(ALICE)/FMD/html");
00028   
00029   THtml* html = new THtml;
00030   html->MakeAll(kFALSE, "AliFMD*");
00031   html->Convert("$(ALICE)/FMD/Digitize.C", "Digitize", 
00032                 "FMD/html/src");
00033   html->Convert("$(ALICE)/FMD/Reconstruct.C", "Reconstruct", 
00034                 "FMD/html/src");
00035   html->Convert("$(ALICE)/FMD/Simulate.C", "Simulate", 
00036                 "FMD/html/src");
00037   html->Convert("$(ALICE)/FMD/DrawFMD.C", "DrawFMD", 
00038                 "FMD/html/src");
00039   html->Convert("$(ALICE)/FMD/ViewFMD.C", "ViewFMD", 
00040                 "FMD/html/src");
00041   html->MakeIndex("AliFMD*");
00042 
00043   std::ofstream index("FMD/html/index.html");
00044   html->WriteHtmlHeader(index, "ALICE FMD Code - Index page");
00045   
00046   index << "<h1>ALICE FMD Code</h1>\n"
00047         << "<ul>\n"
00048         << "<li><a href=\"USER_Index.html\">Classes</a></li>\n"
00049         << "<li><a href=\"src/Digitize.C.html\">Digitize script</a></li>\n"
00050         << "<li><a href=\"src/Reconstruct.C.html\">Reconstruct script</a></li>\n"
00051         << "<li><a href=\"src/Simulate.C.html\">Simulate script</a></li>\n"
00052         << "<li><a href=\"src/DrawFMD.C.html\">DrawFMD script</a></li>\n"
00053         << "<li><a href=\"src/ViewFMD.C.html\">ViewFMD script</a></li>\n"
00054         << "</ul>\n"
00055         << std::endl;
00056   html->WriteHtmlFooter(index, "", "", "", "");
00057   index.close();
00058 }
00059 
00060 //
00061 // EOF
00062 //