Ajout de documentation

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

configpages.h

@@ -63,10 +63,10 @@ class NewDiagramPage : public ConfigPage {
 	
 	// attributs
 	public:
-	QSpinBox *columns_count;
-	QSpinBox *columns_width;
-	QSpinBox *columns_height;
-	InsetPropertiesWidget *ipw;
-	ConductorPropertiesWidget *cpw;
+	QSpinBox *columns_count;        ///< Widget d'edition du nombre par defaut de colonnes
+	QSpinBox *columns_width;        ///< Widget d'edition de la largeur par defaut des colonnes
+	QSpinBox *columns_height;       ///< Widget d'edition de la hauteur par defaut des colonnes
+	InsetPropertiesWidget *ipw;     ///< Widget d'edition des proprietes par defaut du cartouche
+	ConductorPropertiesWidget *cpw; ///< Widget d'edition des proprietes par defaut des conducteurs
 };
 #endif

diagramtextitem.h

@@ -57,6 +57,7 @@ class DiagramTextItem : public QGraphicsTextItem {
 	
 	// signaux
 	signals:
+	/// signal emis lorsque le champ de texte perd le focus
 	void lostFocus();
 	
 	// slots

diagramview.h

@@ -37,6 +37,7 @@ class DiagramView : public QGraphicsView {
 	
 	// attributs
 	public:
+	/// Nom de fichier du schema edite
 	QString file_name;
 	
 	private:

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());       }
 
 /**

element.h

@@ -39,6 +39,13 @@ class Element : public QGraphicsItem {
 	enum { Type = UserType + 1000 };
 	
 	protected:
+	/**
+		orientations de l'element :
+			* autorisations
+			* orientation en cours
+			* orientation par defaut
+		@see OrientationSet
+	*/
 	OrientationSet ori;
 	
 	private:
@@ -128,7 +135,7 @@ inline bool Element::internalConnections() {
 /**
 	Permet de specifier si l'element accepte les connexions internes,
 	c'est-a-dire que ses bornes peuvent etre reliees entre elles
-	@param cia true pour que l'element accepte les connexions internes, false pour
+	@param ic true pour que l'element accepte les connexions internes, false pour
 	qu'il les interdise
 */
 inline void Element::setInternalConnections(bool ic) {

nameslistwidget.h

@@ -58,6 +58,10 @@ class NamesListWidget : public QWidget {
 	void check();
 	
 	signals:
+	/**
+		Signal emis lors de la verification de la saisie s'il y a au moins un
+		nom saisi
+	*/
 	void inputChecked();
 };
 #endif

qetdiagrameditor.h

@@ -98,51 +98,51 @@ class QETDiagramEditor : public QMainWindow {
 	// attributs
 	public:
 	// Actions faisables au travers de menus dans l'application QElectroTech
-	QActionGroup *grp_visu_sel;
-	QAction *mode_selection;
-	QAction *mode_visualise;
-	QAction *new_file;
-	QAction *open_file;
-	QAction *close_file;
-	QAction *save_file;
-	QAction *save_file_sous;
-	QAction *import_diagram;
-	QAction *export_diagram;
-	QAction *print;
-	QAction *quit_editor;
-	QAction *undo;
-	QAction *redo;
-	QAction *cut;
-	QAction *copy;
-	QAction *paste;
-	QAction *select_all;
-	QAction *select_nothing;
-	QAction *select_invert;
-	QAction *delete_selection;
-	QAction *rotate_selection;
-	QAction *conductor_prop;
-	QAction *conductor_reset;
-	QAction *conductor_default;
-	QAction *infos_diagram;
-	QAction *add_text;
-	QAction *add_column;
-	QAction *remove_column;
-	QAction *expand_diagram;
-	QAction *shrink_diagram;
-	QAction *zoom_in;
-	QAction *zoom_out;
-	QAction *zoom_fit;
-	QAction *zoom_reset;
-	QAction *about_qet;
-	QAction *about_qt;
-	QAction *configure;
-	QAction *fullscreen_on;
-	QAction *fullscreen_off;
-	QAction *tile_window;
-	QAction *cascade_window;
-	QAction *arrange_window;
-	QAction *prev_window;
-	QAction *next_window;
+	QActionGroup *grp_visu_sel;  ///< Groupe d'actions pour les modes (edition et visualisation)
+	QAction *mode_selection;     ///< Passe en mode edition
+	QAction *mode_visualise;     ///< Passe en mode visualisation
+	QAction *new_file;           ///< Cree un nouveau schema
+	QAction *open_file;          ///< OUvre un fichier
+	QAction *close_file;         ///< Ferme le fichier
+	QAction *save_file;          ///< Enregistre le fichier
+	QAction *save_file_sous;     ///< Enregistrer le fichier sous un nom donne
+	QAction *import_diagram;     ///< Importe un schema existant (non implemente)
+	QAction *export_diagram;     ///< Exporte le schema sous forme d'image
+	QAction *print;              ///< Imprime le schema
+	QAction *quit_editor;        ///< Quitte l'editeur de schema
+	QAction *undo;               ///< Annule la derniere action
+	QAction *redo;               ///< Refait une action annulee
+	QAction *cut;                ///< Coupe la selection dans le presse-papier
+	QAction *copy;               ///< Copie la selection dans le presse-papier
+	QAction *paste;              ///< Colle le contenu du presse-papier sur le schema
+	QAction *select_all;         ///< Selectionne tout
+	QAction *select_nothing;     ///< Deselectionne tout
+	QAction *select_invert;      ///< Inverse la selection
+	QAction *delete_selection;   ///< Supprime la selection
+	QAction *rotate_selection;   ///< Pivote les elements selectionnes
+	QAction *conductor_prop;     ///< Lance le dialogue d'edition du conducteur selectionne
+	QAction *conductor_reset;    ///< Reinitialise les conducteurs selectionnes
+	QAction *conductor_default;  ///< Lance le dialogue d'edition des conducteurs par defaut
+	QAction *infos_diagram;      ///< Lance le dialogue d'edition des proprietes du schema
+	QAction *add_text;           ///< Passe en mode "Ajout de texte"
+	QAction *add_column;         ///< Ajoute une colonne au schema
+	QAction *remove_column;      ///< Enleve une colonne du schema
+	QAction *expand_diagram;     ///< Augmente la hauteur du schema
+	QAction *shrink_diagram;     ///< Reduit la hauteur du schema
+	QAction *zoom_in;            ///< Zoome avant
+	QAction *zoom_out;           ///< Zoome arriere
+	QAction *zoom_fit;           ///< Ajuste le zoom de facon a voir l'integralite des elements
+	QAction *zoom_reset;         ///< Remet le zoom 1:1
+	QAction *about_qet;          ///< Lance le dialogue "A propos de QElectroTech"
+	QAction *about_qt;           ///< Lance le dialogue "A propos de Qt"
+	QAction *configure;          ///< Lance le dialogue de configuration de QElectroTech
+	QAction *fullscreen_on;      ///< Passe en mode plein ecran
+	QAction *fullscreen_off;     ///< Sort du mode plein ecran
+	QAction *tile_window;        ///< Affiche les fenetre MDI en mosaique
+	QAction *cascade_window;     ///< Affiche les fenetres MDI en cascade
+	QAction *arrange_window;     ///< Reorganise les fenetres MDI
+	QAction *prev_window;        ///< Affiche la fenetre MDI precedente
+	QAction *next_window;        ///< Affiche la fenetre MDI suivante
 	
 	private:
 	QWorkspace workspace;