r17966 by jghali - #11273 : FPoint documentation

[scribus-commit]

Author: jghali
Date: Tue Dec 18 07:30:10 2012
New Revision: 17966

URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=17966
Log:
#11273 : FPoint documentation

Modified:
    trunk/Scribus/scribus/fpoint.h

Modified: trunk/Scribus/scribus/fpoint.h
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=17966&path=/trunk/Scribus/scribus/fpoint.h
==============================================================================
--- trunk/Scribus/scribus/fpoint.h (original)
+++ trunk/Scribus/scribus/fpoint.h Tue Dec 18 07:30:10 2012
@@ -28,8 +28,16 @@
 #include <QPoint>
 #include <QPointF>
 #include "scribusapi.h"
+
 /**
-  *@author Franz Schmid
+  * @author Franz Schmid
+  * @brief A point with floating point precision
+  *
+  * One of the advantage of FPoint vs QPointF is that FPoint has consistent precision across platforms :
+  * the coordinates are systematically stored as double. QPointF uses the qreal typedef which is sometime double,
+  * sometime float.
+  *
+  * FPoint has also some coordinate transformation functionalities not provided by QPointF. 
   */
 
 class SCRIBUS_API FPoint