]> Creatis software - creaMaracasVisu.git/blobdiff - lib/doxygen/DoxyMainPage.txt.in
Tout le travail de documentation de la librairie creaMaracasVisu.Ils étaient ajouté...
[creaMaracasVisu.git] / lib / doxygen / DoxyMainPage.txt.in
index 0e6aa9039173508132ba64930a27d628f7727312..c34ebc5fbfe6dbd32c0d3a46fea99cb4adacbe10 100644 (file)
  * \mainpage creaMaracasVisu documentation
 
 \htmlonly 
-<H2>Architecture Description ?????????? </H2>
-<br>
-<a href="Architecture.htm"> Architecture </a>
-<br>
-
-<H2>Diagrams of the architecture</H2> <br>
-Viewers <br>
-<a href="../wxVtkViewer_classDiagram1_HTML/index.html"> - wxVtkViewer Class Diagram 1</a> <br>
-<a href="../wxVtkViewer_classDiagram2_HTML/index.html"> - wxVtkViewer Class Diagram 2</a> <br>
-<br>
-<a href="../pPlotter_HTML/index.html"> pPlotter Class Diagram</a> <br>
-<br>
-Manual Contour Class Diagram <br>
-<a href="../manualContour_MVC_HTML/index.html"> -MVC (Model View Controler)</a> <br>
-<a href="../manualContour_Model_HTML/index.html"> -Model</a> <br>
-<a href="../manualContour_View_HTML/index.html"> -View</a> <br>
-<a href="../manualContour_Controler_HTML/index.html"> -Controler</a> <br>
-
-<H2>Sequence Diagrams  ?????????? </H2>
-<br>
-<a href="XXXXXX.html"> seg01 </a>
-<br>
+
+<style type="text/css">
+.titles {
+       font-family: Geneva, Arial, Helvetica, sans-serif;
+       color: #000000;
+       font-size: large;
+       font-weight: bold;
+}
+.text {
+       font-family: Geneva, Arial, Helvetica, sans-serif;
+       font-size: small;
+       font-weight: normal;
+}
+a.el {
+font-weight:bold;
+text-decoration:none;
+}
+a {
+color:#1A41A8;
+}
+.subtitles {
+       font-family: Geneva, Arial, Helvetica, sans-serif;
+       font-size: 90%;
+       font-weight: bold;
+       text-decoration: underline;
+}
+.listDiagrams {
+       font-family: Geneva, Arial, Helvetica, sans-serif;
+       margin-left: 25px;
+       font-size: small;
+}
+.paragraph {
+       margin-left: 40px;
+       font-family: Geneva, Arial, Helvetica, sans-serif;
+       font-size: small;
+}
+.style1 {
+       text-decoration: underline;
+}
+</style>
+<H2 class="titles">General Description</H2>
+<H2><span class="text">First of all, <strong> 
+<a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a></strong> is a C++ library developed by 
+<a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/creatools">Creatools</a> 
+software team and it follows the general architecture of Creatools architecture 
+(more information in the 
+<a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaToolsArchitecture">Creatools Architecture</a> diagram.
+<strong> 
+<a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a> </strong> has as principal objective to help the visualization of medical 
+images and the interaction with them. </span></H2>
+<hr />
+
+<H2 class="titles">&nbsp;Architecture Description</H2>
+<H2><span class="text">The core of the library is divided into 
+different modules, and each one provides a list of diferent functionalities that can be 
+used in specific contexts. The principal components are the following:<br />
+<br />
+- <a class="el" href="#ViewersInteractors">Viewers and interactors</a><br />
+- <a class="el" href="#Contours">Contours</a><br />
+- <a class="el" href="#Cutter">Cutter Module</a><br />
+- <a class="el" href="#Plotter">Plotter and Data Representation</a><br />
+
+<br />
+The relationship among this set of elements is described in the following 
+diagram :<br />
+<br />
+&nbsp;&nbsp;&nbsp;&nbsp; - 
+<a class="el" href="../GeneralArchitecture_HTML/index.html">Architecture Diagram</a></span></H2>
+<hr />
+
+<H2 class="titles">&nbsp;Modules Description</H2>
+<p class="text">In this section are presented the corresponding diagrams for 
+each model in <span class="text"> <strong> 
+<a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a> </strong> </span>
+library including classes, components and sequence diagrams, as well as a short 
+description of the module of interest.</p>
+<span class="subtitles"><a name="ViewersInteractors"></a>Viewers and interactors</span><br />
+<br />
+&nbsp;<span class="listDiagrams"><strong><span class="style1">Class diagrams</span><br />
+<br />
+</strong></span><br />
+<span class="listDiagrams">&nbsp;&nbsp;
+<a href="../wxVtkViewer_classDiagram1_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 1</a><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+<a href="../wxVtkViewer_classDiagram2_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 2</a></span><br />
+&nbsp;<br>
+<hr /><span class="subtitles"><a name="Contours"></a>Contours<br />
+<br />
+<strong>
+<span class="listDiagrams">Class diagrams<br />
+<br />
+</span></strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
+       - 
+<a href="../manualContour_MVC_HTML/index.html" class="el"> MVC (Model View Controler)</a> <br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Model_HTML/index.html" class="el">- Model</a> <br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_View_HTML/index.html" class="el">- View</a> <br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Controler_HTML/index.html" class="el">- Controler</a><br />
+       <br />
+</div><span class="subtitles">
+<strong>
+<span class="listDiagrams">Sequence diagrams<br />
+<br />
+</span></strong></span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
+       - 
+<a class="el" href="../manualContour_SeqCreateContour_HTML/index.html">To create a new 
+       contour MVC</a> 
+<div class="paragraph">
+When a new 
+       contour has to be created it is necessary to instantiate the MVC 
+       model shown in the section before. It is important to note that Contours 
+       module needs a viewer to draw and to manage the contour. For that reason, 
+       after creating the model, view and controller and their relations 
+       (Controller uses View and Model, and View has relation with the model), it 
+       is necessary to say the viewer where it will be managed. The specific 
+       methods to do this task are in the diagram.</div><br />
+<hr /><span class="subtitles"><a name="Cutter"></a>Cutter</span><br>
+<span class="subtitles">
+<br />
+<strong>
+<span class="listDiagrams">Component diagrams<br />
+<br />
+</span></strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
+       - 
+<a href="../CutModuleDiagrams_HTML/index.html" class="el"> Cutter module 
+       components </a>
+</div>
+<span class="subtitles">
+<br />
+<strong>
+<span class="listDiagrams">Class diagrams<br />
+<br />
+</span></strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -
+       <a href="../CutModuleDiagrams_HTML/fig141309.png" class="el"> Cutter module 
+       integration </a> <br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../CutModuleDiagrams_HTML/fig134653.png" class="el">- 
+       Interface</a> <br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../CutModuleDiagrams_HTML/fig134781.png" class="el">- 
+       Kernel</a></div>
+<br />
+<hr /><span class="subtitles"><a name="Plotter"></a>Plotter and data representation</span><br>
+
+<br />
+<strong>
+<span class="listDiagrams"><span class="style1">Class diagrams</span><br class="style1" />
+</span></strong><span class="style1"></span></span><br />
+<br />
+<div class="text">
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../pPlotter_HTML/index.html" class="el">- pPlotter Class Diagram</a> <br>
+</div>
+
+
 
 \endhtmlonly