From cce949f32a6a5f7c5a60a48340da707817c63a19 Mon Sep 17 00:00:00 2001
From: Matteo Cypriani <matteo.cypriani@univ-fcomte.fr>
Date: Tue, 14 Jun 2011 16:44:17 +0200
Subject: [PATCH] [Positioning] Fix some Doxygen comments

---
 owlps-positioning/src/csvfilereader.cc   | 2 +-
 owlps-positioning/src/inputmedium.hh     | 4 ++--
 owlps-positioning/src/inputudpsocket.cc  | 4 ++--
 owlps-positioning/src/outputudpsocket.cc | 4 ++--
 owlps-positioning/src/referencepoint.hh  | 6 +++---
 owlps-positioning/src/result.cc          | 2 +-
 owlps-positioning/src/resultlist.cc      | 2 +-
 owlps-positioning/src/textfilereader.cc  | 2 +-
 owlps-positioning/src/textfilewriter.cc  | 4 ++--
 9 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/owlps-positioning/src/csvfilereader.cc b/owlps-positioning/src/csvfilereader.cc
index 81607a2..17fced7 100644
--- a/owlps-positioning/src/csvfilereader.cc
+++ b/owlps-positioning/src/csvfilereader.cc
@@ -24,7 +24,7 @@ CSVFileReader::~CSVFileReader()
 /**
  * Note that this function is not called by the constructor, so you
  * must manually call it prior to use read_field().
- * @return false in case of error (EOF, etc.).
+ * @return \em false in case of error (EOF, etc.), \em true else.
  */
 bool CSVFileReader::next_line()
 {
diff --git a/owlps-positioning/src/inputmedium.hh b/owlps-positioning/src/inputmedium.hh
index c4a7571..81ca9e5 100644
--- a/owlps-positioning/src/inputmedium.hh
+++ b/owlps-positioning/src/inputmedium.hh
@@ -47,8 +47,8 @@ public:
    * Reads a Request, increments current_line_nb, updates #current_request
    * and returns it.
    * @return The Request read, or an empty Request in case of error or
-   * EOF (note that when casted in bool, an empty Request is false, see
-   * Request::operator bool()).
+   * EOF (note that when casted in bool, an empty Request is \em false,
+   * see Request::operator bool()).
    */
   virtual const Request& get_next_request(void) = 0 ;
 
diff --git a/owlps-positioning/src/inputudpsocket.cc b/owlps-positioning/src/inputudpsocket.cc
index 2776542..625bf84 100644
--- a/owlps-positioning/src/inputudpsocket.cc
+++ b/owlps-positioning/src/inputudpsocket.cc
@@ -35,8 +35,8 @@ InputUDPSocket::~InputUDPSocket()
 
 
 /**
- * @return true if the socket were successfully opened, false in case of
- * error.
+ * @return \em true if the socket were successfully opened.
+ * @return \em false in case of error.
  */
 bool InputUDPSocket::init_socket()
 {
diff --git a/owlps-positioning/src/outputudpsocket.cc b/owlps-positioning/src/outputudpsocket.cc
index 6093286..7f4cca1 100644
--- a/owlps-positioning/src/outputudpsocket.cc
+++ b/owlps-positioning/src/outputudpsocket.cc
@@ -36,8 +36,8 @@ OutputUDPSocket::~OutputUDPSocket()
 
 
 /**
- * @return true if the socket were successfully opened, false in case of
- * error.
+ * @return \em true if the socket were successfully opened.
+ * @return \em false in case of error.
  */
 bool OutputUDPSocket::init_socket()
 {
diff --git a/owlps-positioning/src/referencepoint.hh b/owlps-positioning/src/referencepoint.hh
index 717a523..6b6a074 100644
--- a/owlps-positioning/src/referencepoint.hh
+++ b/owlps-positioning/src/referencepoint.hh
@@ -52,11 +52,11 @@ public:
 
   /** @name Operations */
   //@{
-  /// Compute the distance between the ReferencePoint and a Request
+  /// Computes the distance between the ReferencePoint and a Request
   float ss_square_distance(const Request &source) const ;
-  /// Compute the Friis index for the given AccessPoint
+  /// Computes the Friis index for the given AccessPoint
   float friis_index_for_ap(const std::string &ap_mac) const ;
-  /// Compute the Friis indexes sum for the given AccessPoint
+  /// Computes the Friis indexes sum for the given AccessPoint
   float friis_indexes_for_ap(
     const AccessPoint &ap, const double &const_term,
     int &nb_indexes) const ;
diff --git a/owlps-positioning/src/result.cc b/owlps-positioning/src/result.cc
index 817c8f0..149d441 100644
--- a/owlps-positioning/src/result.cc
+++ b/owlps-positioning/src/result.cc
@@ -56,7 +56,7 @@ bool Result::operator==(const Result &source) const
 
 
 /**
- * @return the result as a CSV string, \em without trailing '\n'.
+ * @return The result as a CSV string, \em without trailing '\n'.
  */
 const string Result::to_csv() const
 {
diff --git a/owlps-positioning/src/resultlist.cc b/owlps-positioning/src/resultlist.cc
index 58a6953..c530c66 100644
--- a/owlps-positioning/src/resultlist.cc
+++ b/owlps-positioning/src/resultlist.cc
@@ -46,7 +46,7 @@ bool ResultList::operator==(const ResultList &source) const
 
 
 /**
- * @return the results as a CSV string, \em without trailing '\n'.
+ * @return The results as a CSV string, \em without trailing '\n'.
  */
 const string ResultList::to_csv() const
 {
diff --git a/owlps-positioning/src/textfilereader.cc b/owlps-positioning/src/textfilereader.cc
index 9f9f2cb..75e967c 100644
--- a/owlps-positioning/src/textfilereader.cc
+++ b/owlps-positioning/src/textfilereader.cc
@@ -50,7 +50,7 @@ TextFileReader::~TextFileReader()
  * If the first non-blank character of a line is a #, then the line is
  * skipped (note that comments at the end of a line are *not* handled).
  * @param text Output argument; unchanged in case of error.
- * @return false in case of error, true else.
+ * @return \em false in case of error, \em true else.
  */
 bool TextFileReader::read_nonblank_line(string &text)
 {
diff --git a/owlps-positioning/src/textfilewriter.cc b/owlps-positioning/src/textfilewriter.cc
index a347c31..0e3158f 100644
--- a/owlps-positioning/src/textfilewriter.cc
+++ b/owlps-positioning/src/textfilewriter.cc
@@ -47,8 +47,8 @@ TextFileWriter::~TextFileWriter()
 
 
 /**
- * @return true if the string has been written successfuly, or false
- * if not.
+ * @return \em true if the string has been written successfuly, or
+ * \em false if not.
  */
 bool TextFileWriter::write_text(const string &text)
 {