X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2Fdoxygen%2FDoxyMainPage.txt.in;fp=lib%2Fdoxygen%2FDoxyMainPage.txt.in;h=c34ebc5fbfe6dbd32c0d3a46fea99cb4adacbe10;hb=96facb2168314bc57826afc4342abd43e27f0ff7;hp=0e6aa9039173508132ba64930a27d628f7727312;hpb=17c395434fa5df790cbfe0c2d791384a4c9bad47;p=creaMaracasVisu.git
diff --git a/lib/doxygen/DoxyMainPage.txt.in b/lib/doxygen/DoxyMainPage.txt.in
index 0e6aa90..c34ebc5 100644
--- a/lib/doxygen/DoxyMainPage.txt.in
+++ b/lib/doxygen/DoxyMainPage.txt.in
@@ -2,28 +2,157 @@
* \mainpage creaMaracasVisu documentation
\htmlonly
-Architecture Description ??????????
-
- Architecture
-
-
-Diagrams of the architecture
-Viewers
- - wxVtkViewer Class Diagram 1
- - wxVtkViewer Class Diagram 2
-
- pPlotter Class Diagram
-
-Manual Contour Class Diagram
- -MVC (Model View Controler)
- -Model
- -View
- -Controler
-
-Sequence Diagrams ??????????
-
- seg01
-
+
+
+General Description
+First of all,
+creaMaracasVisu is a C++ library developed by
+Creatools
+software team and it follows the general architecture of Creatools architecture
+(more information in the
+Creatools Architecture diagram.
+
+creaMaracasVisu has as principal objective to help the visualization of medical
+images and the interaction with them.
+
+
+ Architecture Description
+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:
+
+- Viewers and interactors
+- Contours
+- Cutter Module
+- Plotter and Data Representation
+
+
+The relationship among this set of elements is described in the following
+diagram :
+
+ -
+Architecture Diagram
+
+
+ Modules Description
+In this section are presented the corresponding diagrams for
+each model in
+creaMaracasVisu
+library including classes, components and sequence diagrams, as well as a short
+description of the module of interest.
+Viewers and interactors
+
+ Class diagrams
+
+
+
+ - wxVtkViewer Class Diagram 1
+
+ - wxVtkViewer Class Diagram 2
+
+
Contours
+
+
+Class diagrams
+
+
+
+Sequence diagrams
+
+
+ -
+To create a new
+ contour MVC
+
+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.
+
Cutter
+
+
+
+Component diagrams
+
+
+
+
+
+Class diagrams
+
+
+
+
Plotter and data representation
+
+
+
+Class diagrams
+
+
+
+
+
\endhtmlonly
