FMD/scripts/Document.C

   1 /**************************************************************************
   2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   3  *                                                                        *
   4  * Author: The ALICE Off-line Project.                                    *
   5  * Contributors are mentioned in the code where appropriate.              *
   6  *                                                                        *
   7  * Permission to use, copy, modify and distribute this software and its   *
   8  * documentation strictly for non-commercial purposes is hereby granted   *
   9  * without fee, provided that the above copyright notice appears in all   *
  10  * copies and that both the copyright notice and this permission notice   *
  11  * appear in the supporting documentation. The authors make no claims     *
  12  * about the suitability of this software for any purpose. It is          *
  13  * provided "as is" without express or implied warranty.                  *
  14  **************************************************************************/
  15
  16 /* $Id$ */
  17
  18 // Script to document the FMD code
  19 /** @ingroup simple_script
  20  */
  21 void
  22 Document()
  23 {
  24   gEnv->SetValue("Root.Html.SourceDir", "$(ALICE)/FMD");
  25   gEnv->SetValue("Root.Html.OutputDir", "$(ALICE)/FMD/html");
  26
  27   gSystem->MakeDirectory("$(ALICE)/FMD/html");
  28
  29   THtml* html = new THtml;
  30   html->MakeAll(kFALSE, "AliFMD*");
  31   html->Convert("$(ALICE)/FMD/Digitize.C", "Digitize",
  32                 "FMD/html/src");
  33   html->Convert("$(ALICE)/FMD/Reconstruct.C", "Reconstruct",
  34                 "FMD/html/src");
  35   html->Convert("$(ALICE)/FMD/Simulate.C", "Simulate",
  36                 "FMD/html/src");
  37   html->Convert("$(ALICE)/FMD/DrawFMD.C", "DrawFMD",
  38                 "FMD/html/src");
  39   html->Convert("$(ALICE)/FMD/ViewFMD.C", "ViewFMD",
  40                 "FMD/html/src");
  41   html->MakeIndex("AliFMD*");
  42
  43   std::ofstream index("FMD/html/index.html");
  44   html->WriteHtmlHeader(index, "ALICE FMD Code - Index page");
  45
  46   index << "<h1>ALICE FMD Code</h1>\n"
  47         << "<ul>\n"
  48         << "<li><a href=\"USER_Index.html\">Classes</a></li>\n"
  49         << "<li><a href=\"src/Digitize.C.html\">Digitize script</a></li>\n"
  50         << "<li><a href=\"src/Reconstruct.C.html\">Reconstruct script</a></li>\n"
  51         << "<li><a href=\"src/Simulate.C.html\">Simulate script</a></li>\n"
  52         << "<li><a href=\"src/DrawFMD.C.html\">DrawFMD script</a></li>\n"
  53         << "<li><a href=\"src/ViewFMD.C.html\">ViewFMD script</a></li>\n"
  54         << "</ul>\n"
  55         << std::endl;
  56   html->WriteHtmlFooter(index, "", "", "", "");
  57   index.close();
  58 }
  59
  60 //
  61 // EOF
  62 //