]> Creatis software - creaContours.git/blob - lib/doxygen/DoxyMainPage.txt.in
Elements required for the doxygen documentation
[creaContours.git] / lib / doxygen / DoxyMainPage.txt.in
1 /**
2  * \mainpage creaMaracasVisu 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 <h2><span class="text">A gross approximation
88 of&nbsp;<strong><a class="el"
89  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
90 general architectural
91 distribution can be seen in this diagram. In short<strong><a
92  class="el"
93  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
94 creaContours</a></strong> can be
95 thought of as being divided in three parts<span
96  style="font-weight: bold;"></span></span></h2>
97 <ul>
98   <li>
99     <h2><span class="text"><a class="el"
100  href="#Interface_Icons_NDimensions_lib">Interface_Icons_NDimensions_lib</a>.
101 The set of classes that represents&nbsp;<strong><a
102  class="el"
103  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
104 menus and the buttons
105 contained within.</span>&nbsp;<span class="text"></span></h2>
106   </li>
107   <li>
108     <h2><span class="text"><a class="el"
109  href="#Interface_ManagerContour_NDimensions_lib">Interface_ManagerContour_NDimensions_lib</a>.
110 This is where are found the classes that define the functions
111 associated to the creation and edition of the contours. </span></h2>
112   </li>
113   <li>
114     <h2><span class="text"><a class="el"
115  href="#kernel_ManagerContour_NDimensions_li">kernel_ManagerContour_NDimensions_lib</a>.
116 As its name suggests, this is the group of classes that constitute the
117 kernel of the application. These are multiple-purpose classes that
118 serve as building blocks for the rest of&nbsp;<strong><a
119  class="el"
120  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>.<br />
121     </span></h2>
122   </li>
123 </ul>
124 <ul>
125 </ul>
126 <hr />
127 <h2 style="text-align: left;" class="style4">Modules
128 Description</h2>
129 <p class="text">In this section, each module of<span
130  class="text"><strong><a class="el"
131  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
132 creaContours</a></strong></span> is fleshed out
133 through class,&nbsp;sequence and component diagrams. The objective
134 is to provide as much useful information about each component as it is
135 possible.</p>
136 <a name="Interface_Icons_NDimensions_lib"></a>
137 <div class="style3"> Interface_Icons_NDimensions_lib</div>
138 <br />
139 <span class="text"></span><span
140  class="listDiagrams"></span>
141 <br />
142 <hr /><span class="subtitles"><a
143  name="Interface_ManagerContour_NDimensions_lib"></a></span>
144 <br />
145 <div class="style3">Interface_ManagerContour_NDimensions_lib</div>
146 <br />
147 <hr /><a name="kernel_ManagerContour_NDimensions_li"></a>
148 <div class="style3">kernel_ManagerContour_NDimensions_lib</div>
149 <br />
150 <hr /><span class="style3"></span><br />
151 <span class="listDiagrams"></span><br />
152
153
154 <!-- ******************************************************************************* -->
155 <!--         End HTML Code         -->
156 <!-- ******************************************************************************* -->
157
158 \endhtmlonly
159
160          
161  */