From 9fca1926f96f5c9b2f2629fc9b2b49009c7444d3 Mon Sep 17 00:00:00 2001
From: Matteo Cypriani <matteo.cypriani@uqat.ca>
Date: Wed, 3 Jul 2013 10:11:35 -0400
Subject: [PATCH] [Positioner] CSVStringReader: doc improvement

Improve the description of CSVStringReader::read_point3d().
---
 owlps-positioner/csvstringreader.cc | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/owlps-positioner/csvstringreader.cc b/owlps-positioner/csvstringreader.cc
index f58b7ee..6ac5a12 100644
--- a/owlps-positioner/csvstringreader.cc
+++ b/owlps-positioner/csvstringreader.cc
@@ -115,6 +115,12 @@ bool CSVStringReader::read_timestamp(Timestamp &t)
 /**
  * The first field (X) can start with an opening parenthesis, and the
  * last one (Z) can finish with a closing parenthesis.
+ *
+ * @param[out] p The variable in which the read Point3D will be stored.
+ * It is left untouched if a full Point3D cannot be read successfuly.
+ *
+ * @returns `true` if the Point3D was read successfuly.
+ * @returns `false` in case of error.
  */
 bool CSVStringReader::read_point3d(Point3D &p)
 {