lib/doxygen/DoxyMainPage.txt.in

   1 /**
   2  * \mainpage creaContours documentation
   3
   4 \htmlonly
   5
   6 <!-- ******************************************************************************* -->
   7 <!-- Paste here the new code HTML for the main page of creaMaracasVisu documentation -->
   8 <!-- It is possible to use the file TemplateHomeLibDoxygen.html to edit easily -->
   9 <!-- but don't forget to delete head and body tags. RaC -->
  10 <!-- ******************************************************************************* -->
  11
  12   <meta content="text/html; charset=utf-8"
  13  http-equiv="Content-Type" />
  14   <title>General Description</title>
  15   <style type="text/css">
  16 .titles {
  17 font-family: Geneva, Arial, Helvetica, sans-serif;
  18 color: #000000;
  19 font-size: large;
  20 font-weight: bold;
  21 }
  22 .text {
  23 font-family: Geneva, Arial, Helvetica, sans-serif;
  24 font-size: small;
  25 font-weight: normal;
  26 }
  27 a.el {
  28 font-weight:bold;
  29 text-decoration:none;
  30 }
  31 a {
  32 color:#1A41A8;
  33 }
  34 .subtitles {
  35 font-family: Geneva, Arial, Helvetica, sans-serif;
  36 font-size: 90%;
  37 font-weight: bold;
  38 text-decoration: underline;
  39 }
  40 .listDiagrams {
  41 font-family: Geneva, Arial, Helvetica, sans-serif;
  42 margin-left: 25px;
  43 font-size: small;
  44 font-weight: bold;
  45 }
  46 .paragraph {
  47 margin-left: 40px;
  48 font-family: Geneva, Arial, Helvetica, sans-serif;
  49 font-size: small;
  50 }
  51 .style1 {
  52 text-decoration: underline;
  53 font-weight: bold;
  54 }
  55 .style3 {
  56 font-family: Geneva, Arial, Helvetica, sans-serif;
  57 font-size: 21px;
  58 text-decoration: underline;
  59 text-align: justify;
  60 }
  61 .style4 {
  62 font-family: Geneva, Arial, Helvetica, sans-serif;
  63 color: #000000;
  64 font-size: x-large;
  65 font-weight: bold;
  66 text-align: center;
  67 }
  68   </style>
  69 </head>
  70 <body>
  71 <h2 style="text-align: left;" class="style4">General
  72 Description</h2>
  73 <h2><span class="text"><strong><a class="el"
  74  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>
  75 is a C++ application developed by the <a class="el"
  76  href="http://www.creatis.insa-lyon.fr/site/fr/creatools">CreaTools</a>
  77 software team. As such, it is contained within the&nbsp;CreaTools <a
  78  class="el"
  79  href="http://www.creatis.insa-lyon.fr/site/fr/CreaToolsArchitecture">general
  80 architecture</a>. Its principal objective as a standalone
  81 application is to let the user create flexible contour shapes over
  82 different kinds of images. The drawn contours can afterwards by used to
  83 extract statistical information out of these images. </span></h2>
  84 <hr />
  85 <h2 style="text-align: left;" class="style4">Architecture
  86 Description</h2>
  87
  88 <h2>
  89   <span class="text">
  90     Here the <a class="el" href="../GeneralArchitecture_HTML/index.html">General Architecture</a>
  91   </span>
  92 </h2>
  93
  94
  95 <h2><span class="text">A gross approximation
  96 of&nbsp;<strong><a class="el"
  97  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
  98 general architectural
  99 distribution can be seen in this diagram. In short<strong><a
 100  class="el"
 101  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
 102 creaContours</a></strong> can be
 103 thought of as being divided in three parts<span
 104  style="font-weight: bold;"></span></span></h2>
 105 <ul>
 106   <li>
 107     <h2><span class="text"><a class="el"
 108  href="#Interface_Icons_NDimensions_lib">Interface_Icons_NDimensions_lib</a>.
 109 The set of classes that represents&nbsp;<strong><a
 110  class="el"
 111  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
 112 menus and the buttons
 113 contained within.</span>&nbsp;<span class="text"></span></h2>
 114   </li>
 115   <li>
 116     <h2><span class="text"><a class="el"
 117  href="#Interface_ManagerContour_NDimensions_lib">Interface_ManagerContour_NDimensions_lib</a>.
 118 This is where are found the classes that define the functions
 119 associated to the creation and edition of the contours. </span></h2>
 120   </li>
 121   <li>
 122     <h2><span class="text"><a class="el"
 123  href="#kernel_ManagerContour_NDimensions_li">kernel_ManagerContour_NDimensions_lib</a>.
 124 As its name suggests, this is the group of classes that constitute the
 125 kernel of the application. These are multiple-purpose classes that
 126 serve as building blocks for the rest of&nbsp;<strong><a
 127  class="el"
 128  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>.<br />
 129     </span></h2>
 130   </li>
 131 </ul>
 132 <ul>
 133 </ul>
 134 <hr />
 135 <h2 style="text-align: left;" class="style4">Modules
 136 Description</h2>
 137 <p class="text">In this section, each module of<span
 138  class="text"><strong><a class="el"
 139  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
 140 creaContours</a></strong></span> is fleshed out
 141 through class,&nbsp;sequence and component diagrams. The objective
 142 is to provide as much useful information about each component as it is
 143 possible.</p>
 144 <a name="Interface_Icons_NDimensions_lib"></a>
 145 <div class="style3"> Interface_Icons_NDimensions_lib</div>
 146 <br />
 147 <span class="text"></span><span
 148  class="listDiagrams"></span>
 149 <br />
 150 <hr /><span class="subtitles"><a
 151  name="Interface_ManagerContour_NDimensions_lib"></a></span>
 152 <br />
 153 <div class="style3">Interface_ManagerContour_NDimensions_lib</div>
 154 <br />
 155 <hr /><a name="kernel_ManagerContour_NDimensions_li"></a>
 156 <div class="style3">kernel_ManagerContour_NDimensions_lib</div>
 157 <br />
 158 <hr /><span class="style3"></span><br />
 159 <span class="listDiagrams"></span><br />
 160
 161
 162 <!-- ******************************************************************************* -->
 163 <!--         End HTML Code         -->
 164 <!-- ******************************************************************************* -->
 165
 166 \endhtmlonly
 167
 168
 169  */