Addition to KKJ class documentation.

[ptas] / src / kkj.h

diff --git a/src/kkj.h b/src/kkj.h
index ac148fa..898cc5f 100644 (file)
--- a/src/kkj.h
+++ b/src/kkj.h
@@ -7,6 +7,7 @@ class KKJPrivate;
 
 /**
  * A class representing the Finnish KKJ coordinate.
+ * This is the rectangular grid coordinate version.
  */
 class KKJ
 {
@@ -24,6 +25,22 @@ public:
     virtual ~KKJ();
 
     /**
+     * Equals operator.
+     * Tests the equality of this coordinate and another coordinate and returns \c true
+     * if the coordinates represent the same position.
+     * @param rhs the other coordinate to test against.
+     * @return \c true if the coordinates are the same, \c false otherwise.
+     */
+    bool operator==(const KKJ &rhs) const;
+
+    /**
+     * Assignment operator.
+     * @param rhs the object that is copied.
+     * @return this object.
+     */
+    KKJ& operator=(const KKJ &rhs);
+
+    /**
      * Returns the northing of the coordinate.
      * @return the northing.
      */