Ajout de documentation

Ajout du fichier Doxyfile pour parametrer la generation de la documentation


git-svn-id: svn+ssh://svn.tuxfamily.org/svnroot/qet/qet/trunk@191 bfdf4180-ca20-0410-9c96-a3a8aa849046

editor/arceditor.h

@@ -3,6 +3,10 @@
 #include <QtGui>
 #include "elementitemeditor.h"
 class PartArc;
+/**
+	Cette classe represente le widget d'edition d'un arc dans l'editeur
+	d'element.
+*/
 class ArcEditor : public ElementItemEditor {
 	Q_OBJECT
 	//constructeurs, destructeur

editor/customelementgraphicpart.h

@@ -4,12 +4,12 @@
 #include "customelementpart.h"
 #include "styleeditor.h"
 class QETElementEditor;
+typedef CustomElementGraphicPart CEGP;
 /**
 	Cette classe represente une partie graphique d'element
 	Elle encapsule des methodes afin de gerer les attributs de style communs
 	a la plupart des parties d'elements 
 */
-typedef CustomElementGraphicPart CEGP;
 class CustomElementGraphicPart : public CustomElementPart {
 	public:
 	enum LineStyle { NormalStyle, DashedStyle };

editor/editorcommands.cpp

@@ -337,7 +337,7 @@ void ChangeOrientationsCommand::redo() {
 
 /**
 	Constructeur
-	@param element ElementScene concernee
+	@param elmt ElementScene concernee
 	@param o Option decrivant le type de traitement applique aux zValues des parties de l'element
 	@param parent QUndoCommand parent
 */

editor/elementitemeditor.cpp

@@ -31,7 +31,7 @@ QUndoStack &ElementItemEditor::undoStack() const {
 /**
 	Ajoute une ChangePartCommand a l'UndoStack. L'ancienne valeur sera
 	automatiquement recuperee.
-	@param name   nom de la propriete modifiee
+	@param desc   nom de la propriete modifiee
 	@param part   partie modifiee
 	@param prop   propriete modifiee
 	@param new_v  nouvelle valeur

editor/elementitemeditor.h

@@ -4,6 +4,12 @@
 class QETElementEditor;
 class ElementScene;
 class CustomElementPart;
+/**
+	Cette classe est la classe de base pour les editeurs de aprties dans
+	l'editeur d'element. Elle fournit des methodes pour acceder facilement
+	a l'editeur, a la pile d'annulation, a la scene d'edition ou encore pour
+	ajouter facilement une annulation de type ChangePartCommand.
+*/
 class ElementItemEditor : public QWidget {
 	Q_OBJECT
 	// constructeurs, destructeur

editor/elementscene.cpp

@@ -263,7 +263,7 @@ void ElementScene::drawBackground(QPainter *p, const QRectF &r) {
 }
 
 /**
-	Dessine l'arriere-plan de l'editeur, cad l'indicateur de hotspotó.
+	Dessine l'arriere-plan de l'editeur, cad l'indicateur de hotspot.
 	@param p Le QPainter a utiliser pour dessiner
 	@param r Le rectangle de la zone a dessiner
 */

editor/elementscene.h

@@ -11,6 +11,12 @@ class PartEllipse;
 class PartCircle;
 class PartPolygon;
 class PartArc;
+/**
+	Cette classe est le canevas permettant l'edition d'un element electrique.
+	Elle regroupe les differentes parties composant le dessin de l'element mais
+	egalement les informations complementaires : dimensions, orientations,
+	noms.
+*/
 class ElementScene : public QGraphicsScene {
 	Q_OBJECT
 	

editor/elementview.h

@@ -2,6 +2,10 @@
 #define ELEMENT_VIEW_H
 #include <QGraphicsView>
 #include "elementscene.h"
+/**
+	Cette classe represente un widget permettant de visualiser une
+	ElementScene, c'est-a-dire la classe d'edition des elements.
+*/
 class ElementView : public QGraphicsView {
 	Q_OBJECT
 	// constructeurs, destructeur

editor/ellipseeditor.h

@@ -3,6 +3,10 @@
 #include <QtGui>
 #include "elementitemeditor.h"
 class PartEllipse;
+/**
+	Cette classe represente le widget d'edition d'une ellipse dans l'editeur
+	d'element.
+*/
 class EllipseEditor : public ElementItemEditor {
 	Q_OBJECT
 	//constructeurs, destructeur

editor/lineeditor.h

@@ -3,6 +3,10 @@
 #include <QtGui>
 #include "elementitemeditor.h"
 class PartLine;
+/**
+	Cette classe represente le widget d'edition d'une ligne dans l'editeur
+	d'element.
+*/
 class LineEditor : public ElementItemEditor {
 	Q_OBJECT
 	//constructeurs, destructeur

editor/partarc.h

@@ -3,6 +3,10 @@
 #include <QtGui>
 #include "customelementgraphicpart.h"
 class ArcEditor;
+/**
+	Cette classe represente un arc pouvant etre utilise pour composer le
+	dessin d'un element dans l'editeur d'element.
+*/
 class PartArc : public QGraphicsEllipseItem, public CustomElementGraphicPart {
 	// constructeurs, destructeur
 	public:

editor/partcircle.h

@@ -3,6 +3,10 @@
 #include <QtGui>
 #include "customelementgraphicpart.h"
 class CircleEditor;
+/**
+	Cette classe represente un cercle pouvant etre utilise pour composer le
+	dessin d'un element dans l'editeur d'element.
+*/
 class PartCircle : public QGraphicsEllipseItem, public CustomElementGraphicPart {
 	// constructeurs, destructeur
 	public:

editor/partellipse.h

@@ -3,6 +3,10 @@
 #include <QtGui>
 #include "customelementgraphicpart.h"
 class EllipseEditor;
+/**
+	Cette classe represente une ellipse pouvant etre utilisee pour composer le
+	dessin d'un element dans l'editeur d'element.
+*/
 class PartEllipse : public QGraphicsEllipseItem, public CustomElementGraphicPart {
 	// constructeurs, destructeur
 	public:

editor/partline.h

@@ -3,6 +3,10 @@
 #include <QtGui>
 #include "customelementgraphicpart.h"
 class LineEditor;
+/**
+	Cette classe represente une ligne pouvant etre utilisee pour composer le
+	dessin d'un element dans l'editeur d'element.
+*/
 class PartLine : public QGraphicsLineItem, public CustomElementGraphicPart {
 	// constructeurs, destructeur
 	public:

editor/partpolygon.h

@@ -3,6 +3,10 @@
 #include <QtGui>
 #include "customelementgraphicpart.h"
 class PolygonEditor;
+/**
+	Cette classe represente un polygone pouvant etre utilise pour composer le
+	dessin d'un element dans l'editeur d'element.
+*/
 class PartPolygon : public QGraphicsPolygonItem, public CustomElementGraphicPart {
 	// constructeurs, destructeur
 	public:

editor/partterminal.h

@@ -5,6 +5,10 @@
 #include <QtGui>
 class TerminalEditor;
 class QETElementEditor;
+/**
+	Cette classe represente une borne pouvant etre utilisee pour composer le
+	dessin d'un element dans l'editeur d'element.
+*/
 class PartTerminal : public CustomElementPart, public QGraphicsItem {
 	public:
 	// constructeurs, destructeur

editor/parttext.h

@@ -3,6 +3,10 @@
 #include <QtGui>
 #include "customelementpart.h"
 class TextEditor;
+/**
+	Cette classe represente un texte pouvant etre utilise pour composer le
+	dessin d'un element dans l'editeur d'element.
+*/
 class PartText : public QGraphicsTextItem, public CustomElementPart {
 	// constructeurs, destructeur
 	public:

editor/parttextfield.h

@@ -4,6 +4,12 @@
 #include "customelementpart.h"
 class TextFieldEditor;
 class QETElementEditor;
+/**
+	Cette classe represente un champ de texte editable pouvant etre utilise
+	pour composer le dessin d'un element dans l'editeur d'element.
+	L'utilisateur peut specifier un valeur par defaut. Le champ sera editable
+	lorsque l'element sera pose sur un schema.
+*/
 class PartTextField : public QGraphicsTextItem, public CustomElementPart {
 	// constructeurs, destructeur
 	public:

editor/polygoneditor.h

@@ -2,6 +2,10 @@
 #define POLYGON_EDITOR_H
 #include "elementitemeditor.h"
 class PartPolygon;
+/**
+	Cette classe represente le widget d'edition d'un polygone dans l'editeur
+	d'element.
+*/
 class PolygonEditor : public ElementItemEditor {
 	
 	Q_OBJECT

editor/qetelementeditor.h

@@ -4,6 +4,11 @@
 #include "elementscene.h"
 #include "orientationset.h"
 class ElementView;
+/**
+	Cette classe represente un editeur d'element. Elle permet a l'utilisateur
+	de dessiner, modifier et parametrer un element electrique. Le dessin se
+	fait par ajout de parties (Part).
+*/
 class QETElementEditor : public QMainWindow {
 	Q_OBJECT
 	

editor/styleeditor.h

@@ -3,6 +3,12 @@
 #include <QtGui>
 #include "elementitemeditor.h"
 class CustomElementGraphicPart;
+/**
+	Cette classe represente un widget d'edition des styles que peut comporter
+	une partie d'elements (couleur, epaisseur et style du trait, remplissage,
+	antialiasing). Elle peut accueillir un widget sous cette interface grace a
+	la methode appendWidget.
+*/
 class StyleEditor : public ElementItemEditor {
 	Q_OBJECT
 	// constructeurs, destructeur

editor/texteditor.cpp

@@ -3,7 +3,8 @@
 
 /**
 	Constructeur
-	@param term Champ de texte a editer
+	@param editor L'editeur d'element concerne
+	@param text Champ de texte a editer
 	@param parent QWidget parent de ce widget
 */
 TextEditor::TextEditor(QETElementEditor *editor, PartText *text, QWidget *parent) : ElementItemEditor(editor, parent) {

editor/textfieldeditor.cpp

@@ -3,7 +3,8 @@
 
 /**
 	Constructeur
-	@param part Champ de texte a editer
+	@param editor L'editeur d'element concerne
+	@param textfield Champ de texte a editer
 	@param parent QWidget parent
 */
 TextFieldEditor::TextFieldEditor(QETElementEditor *editor, PartTextField *textfield, QWidget *parent) : ElementItemEditor(editor, parent) {