Ajout de documentation

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

editor/customelementgraphicpart.h

@@ -29,10 +29,31 @@ typedef CustomElementGraphicPart CEGP;
 */
 class CustomElementGraphicPart : public CustomElementPart {
 	public:
-	enum LineStyle { NormalStyle, DashedStyle };
-	enum LineWeight { NormalWeight, ThinWeight, NoneWeight };
-	enum Filling { NoneFilling, BlackFilling, WhiteFilling };
-	enum Color { BlackColor, WhiteColor };
+	/// Qualifie le style de ligne utilise pour dessiner la partie
+	enum LineStyle {
+		NormalStyle, ///< Ligne pleine
+		DashedStyle  ///< Ligne pointillee
+	};
+	
+	/// Qualifie l'epaisseur de ligne utilisee pour dessiner la partie
+	enum LineWeight {
+		NormalWeight, ///< Ligne normale
+		ThinWeight,   ///< Ligne fine
+		NoneWeight    ///< Ligne invisible
+	};
+	
+	/// Qualifie la couleur utilisee pour remplir la partie
+	enum Filling {
+		NoneFilling,  ///< Remplissage transparent
+		BlackFilling, ///< Remplissage en noir
+		WhiteFilling  ///< Remplissage en blanc
+	};
+	
+	/// Qualifie la couleur de ligne utilisee pour dessiner la partie
+	enum Color {
+		BlackColor, ///< Ligne noire
+		WhiteColor  ///< Ligne blanche
+	};
 	
 	// constructeurs, destructeur
 	public:
@@ -65,6 +86,7 @@ class CustomElementGraphicPart : public CustomElementPart {
 	bool _antialiased;
 	
 	protected:
+	/// Widget d'edition des styles de cette partie graphique
 	StyleEditor *style_editor;
 	
 	//methodes

editor/editorcommands.h

@@ -249,7 +249,13 @@ class ChangeOrientationsCommand : public QUndoCommand {
 class ChangeZValueCommand : public QUndoCommand {
 	// constructeurs, destructeur
 	public:
-	enum Option { BringForward, Raise, Lower, SendBackward };
+	/// Qualifie le type de changement de zValue
+	enum Option {
+		BringForward, ///< Amene la partie a l'avant-plan ; elle a alors la plus haute zValue
+		Raise,        ///< Amene la partie un plan au-dessus ; la zValue de la partie est incrementee
+		Lower,        ///< Envoie la partie un plan en-dessous ; la zValue de la partie est decrementee
+		SendBackward  ///< Envoie la partie a l'arriere-plan ; elle a alors la plus faible zValue
+	};
 	ChangeZValueCommand(ElementScene *, Option, QUndoCommand * = 0);
 	virtual ~ChangeZValueCommand();
 	private:

editor/elementscene.h

@@ -50,8 +50,8 @@ class ElementScene : public QGraphicsScene {
 	
 	// attributs
 	public:
-	static const int xGrid;
-	static const int yGrid;
+	static const int xGrid; ///< Taille horizontale de la grille
+	static const int yGrid; ///< Taille verticale de la grille
 	
 	private:
 	/// longueur de l'element en dizaines de pixels
@@ -84,13 +84,13 @@ class ElementScene : public QGraphicsScene {
 	
 	// methodes
 	public:
-	void setWidth(const uint& theValue);
+	void setWidth(const uint &);
 	uint width() const;
-	void setHeight(const uint& theValue);
+	void setHeight(const uint &);
 	uint height() const;
 	void setHotspot(const QPoint &);
 	QPoint hotspot() const;
-	void setNames(const NamesList);
+	void setNames(const NamesList &);
 	NamesList names() const;
 	OrientationSet orientations();
 	void setOrientations(const OrientationSet &);
@@ -135,10 +135,18 @@ class ElementScene : public QGraphicsScene {
 	void slot_sendBackward();
 	
 	signals:
+	/// Signal emis lorsque la selection change
 	void selectionChanged();
+	/**
+		Signal emis lorsque la scene exige que l'editeur d'element repasse
+		en mode normal
+	*/
 	void needNormalMode();
+	/// Signal emis lorsqu'une ou plusieurs parties sont ajoutees
 	void partsAdded();
+	/// Signal emis lorsqu'une ou plusieurs parties sont enlevees
 	void partsRemoved();
+	/// Signal emis lorsque la zValue d'une ou plusieurs parties change
 	void partsZValueChanged();
 };
 
@@ -159,7 +167,7 @@ inline uint ElementScene::width() const {
 }
 
 /**
-	@param wid Nouvelle hauteur de l'element edite
+	@param hei Nouvelle hauteur de l'element edite
 */
 inline void ElementScene::setHeight(const uint &hei) {
 	_height = hei;
@@ -189,9 +197,9 @@ inline QPoint ElementScene::hotspot() const {
 }
 
 /**
-	@param hs Nouvel ensemble de noms de l'element edite
+	@param nameslist Nouvel ensemble de noms de l'element edite
 */
-inline void ElementScene::setNames(const NamesList nameslist) {
+inline void ElementScene::setNames(const NamesList &nameslist) {
 	_names = nameslist;
 }
 

editor/texteditor.cpp

@@ -75,9 +75,13 @@ void TextEditor::updateText() {
 	part -> setPos(qle_x -> text().toDouble(), qle_y -> text().toDouble());
 }
 
+/// Met a jour l'abscisse de la position du texte et cree un objet d'annulation
 void TextEditor::updateTextX() { addChangePartCommand(tr("abscisse"),    part, "x",    qle_x -> text().toDouble()); updateForm(); }
+/// Met a jour l'ordonnee de la position du texte et cree un objet d'annulation
 void TextEditor::updateTextY() { addChangePartCommand(tr("ordonn\351e"), part, "y",    qle_y -> text().toDouble()); updateForm(); }
+/// Met a jour le texte et cree un objet d'annulation
 void TextEditor::updateTextT() { addChangePartCommand(tr("texte"),       part, "text", qle_text -> text());         }
+/// Met a jour la taille du texte et cree un objet d'annulation
 void TextEditor::updateTextS() { addChangePartCommand(tr("taille"),      part, "size", font_size -> value());       }
 
 /**