From b4b61ad6f0e306c72c70d3460425d65eaf0d7443 Mon Sep 17 00:00:00 2001
From: xavierqet
 <xavierqet@r9  xavierqet  2006-10-30 20:28:16 +0100 (lun. 30 oct. 2006)>
Date: Sun, 9 Dec 2007 10:07:33 +0000
Subject: [PATCH] Ajout de documentation

git-svn-id: svn+ssh://svn.tuxfamily.org/svnroot/qet/qet/trunk@225 bfdf4180-ca20-0410-9c96-a3a8aa849046
---
 editor/partpolygon.h      |  1 +
 editor/qetelementeditor.h | 30 ++++++++++++++++++++++++++++++
 orientationset.h          | 22 +++++++++++++++++++++-
 3 files changed, 52 insertions(+), 1 deletion(-)

diff --git a/editor/partpolygon.h b/editor/partpolygon.h
index 39db9eae2..ed87c8e4f 100644
--- a/editor/partpolygon.h
+++ b/editor/partpolygon.h
@@ -66,6 +66,7 @@ class PartPolygon : public QGraphicsPolygonItem, public CustomElementGraphicPart
 	protected:
 	QVariant itemChange(GraphicsItemChange, const QVariant &);
 };
+
 /**
 	Specifie si le polygone doit etre ferme
 	@param c true pour un polygone ferme, false sinon
diff --git a/editor/qetelementeditor.h b/editor/qetelementeditor.h
index 8938df9fb..e9996215c 100644
--- a/editor/qetelementeditor.h
+++ b/editor/qetelementeditor.h
@@ -119,11 +119,17 @@ class QETElementEditor : public QMainWindow {
 	void xmlPreview();
 };
 
+/**
+	@param siz La nouvelle taille de l'element edite
+*/
 inline void QETElementEditor::setSize(const QSize &siz) {
 	ce_scene -> setWidth(siz.width());
 	ce_scene -> setHeight(siz.height());
 }
 
+/**
+	@return la taille de l'element edite
+*/
 inline QSize QETElementEditor::size() const {
 	return(
 		QSize(
@@ -133,35 +139,59 @@ inline QSize QETElementEditor::size() const {
 	);
 }
 
+/**
+	@param hs Le nouveau point de saisie de l'element edite
+*/
 inline void QETElementEditor::setHotspot(const QPoint &hs) {
 	ce_scene -> setHotspot(hs);
 }
 
+/**
+	@return le point de saisie de l'element edite
+*/
 inline QPoint QETElementEditor::hotspot() const {
 	return(ce_scene -> hotspot());
 }
 
+/**
+	@param nameslist le nouvel ensemble de noms de l'element edite
+*/
 inline void QETElementEditor::setNames(const NamesList &nameslist) {
 	ce_scene -> setNames(nameslist);
 }
 
+/**
+	@param orientation_set le nouvel ensemble d'orientations de l'element edite
+*/
 inline void QETElementEditor::setOrientations(const OrientationSet &orientation_set) {
 	ce_scene -> setOrientations(orientation_set);
 }
 
+/**
+	@return le nouvel ensemble d'orientations de l'element edite
+*/
 inline OrientationSet QETElementEditor::orientations() const {
 	return(ce_scene -> orientations());
 }
 
+/**
+	@param fn Le nouveau nom de fichier de l'element edite
+*/
 inline void QETElementEditor::setFileName(const QString &fn) {
 	_filename = fn;
 	slot_updateTitle();
 }
 
+/**
+	@return le nomde fichier de l'element edite
+*/
 inline QString QETElementEditor::fileName() const {
 	return(_filename);
 }
 
+/**
+	@return la scene d'edition de l'element
+*/
 inline ElementScene *QETElementEditor::elementScene() const {
 	return(ce_scene);
 }
diff --git a/orientationset.h b/orientationset.h
index 264730244..dfbda4242 100644
--- a/orientationset.h
+++ b/orientationset.h
@@ -73,31 +73,51 @@ class OrientationSet {
 	QString toString() const;
 };
 
+/**
+	@return true si l'orientation "Nord" est autorisee, false sinon
+*/
 inline bool OrientationSet::north() const {
 	return(north_ori);
 }
 
+/**
+	@return true si l'orientation "Est" est autorisee, false sinon
+*/
 inline bool OrientationSet::east() const {
 	return(east_ori);
 }
 
+/**
+	@return true si l'orientation "Sud" est autorisee, false sinon
+*/
 inline bool OrientationSet::south() const {
 	return(south_ori);
 }
 
+/**
+	@return true si l'orientation "Ouest" est autorisee, false sinon
+*/
 inline bool OrientationSet::west() const {
 	return(west_ori);
 }
 
+/**
+	@param theValue La nouvelle orientation par defaut
+*/
 inline void OrientationSet::setDefaultOrientation(const QET::Orientation& theValue) {
 	default_ori = theValue;
-	
 }
 
+/**
+	@return L'orientation par defaut
+*/
 inline QET::Orientation OrientationSet::defaultOrientation() const {
 	return(default_ori);
 }
 
+/**
+	@return L'orientation actuelle
+*/
 inline QET::Orientation OrientationSet::current() const {
 	return(current_ori);
 }