[Positioning] *.hh: fix typos in comments

owlps-positioning/src/calibrationrequest.hh

@@ -10,9 +10,9 @@ class ReferencePoint ;
 class CalibrationRequest: public Request
 {
 protected:
-  /// The reference point the mobile calibrates
+  /// Reference point that the mobile calibrates
   ReferencePoint *reference_point ;
-  /// The direction in which the mobile was during the measurement
+  /// Direction in which the mobile was during the measurement
   Direction direction ;
 
 public:
@@ -39,7 +39,7 @@ public:
   //@{
   void set_direction(const Direction &_direction) ;
   void set_reference_point(const ReferencePoint *_rp) ;
-  /// Add the CalibrationRequest to the #reference_point list of requests
+  /// Adds the CalibrationRequest to the #reference_point list of requests
   void reference_point_backward_link(void) const ;
   void clear(void) ;
   //@}
@@ -51,7 +51,7 @@ public:
   bool operator!=(const CalibrationRequest &source) const ;
   //@}
 
-  /// Hash a CalibrationRequest
+  /// Hashes a CalibrationRequest
   friend std::size_t hash_value(const CalibrationRequest &source) ;
 } ;
 

owlps-positioning/src/configuration.cc

@@ -47,6 +47,10 @@ bool Configuration::bool_value(const string &key)
 }
 
 
+/**
+ * @return \em true if the string \em value exists in the vector \em key.
+ * @return \em false if \em value is not found in \em key.
+ */
 bool Configuration::
 value_exists_in_string_vector(const string &key, const string &value)
 {
@@ -64,7 +68,8 @@ value_exists_in_string_vector(const string &key, const string &value)
 }
 
 
-const vector<string>& Configuration::string_vector_value(const string &key)
+const vector<string>& Configuration::
+string_vector_value(const string &key)
 {
   return configuration[key].as< vector<string> >() ;
 }

owlps-positioning/src/configuration.hh

@@ -12,21 +12,22 @@ private:
   /// Configuration structure
   static boost::program_options::variables_map configuration ;
 
-
 public:
-  /// Get a reference to the configuration structure
+  /// Returns a reference to the configuration structure
   static boost::program_options::variables_map& getw_configuration(void) ;
   /// Checks if the key exists in the configuration
   static bool is_configured(const std::string &key) ;
-  /// Get the string value corresponding to \em key
+  /// Returns the string value corresponding to \em key
   static const std::string& string_value(const std::string &key) ;
-  /// Get the int value corresponding to \em key
+  /// Returns the int value corresponding to \em key
   static int int_value(const std::string &key) ;
-  /// Get the bool value corresponding to \em key
+  /// Returns the bool value corresponding to \em key
   static bool bool_value(const std::string &key) ;
+  /// Checks if a given string value exists in \em key
   static bool value_exists_in_string_vector(
     const std::string &key,
     const std::string &value) ;
+  /// Returns the vector value corresponding to \em key
   static const std::vector<std::string>&
   string_vector_value(const std::string &key) ;
 } ;

owlps-positioning/src/csvfilereader.hh

@@ -33,13 +33,13 @@ public:
 
   /** @name Operations */
   //@{
-  /// Load the first next non-blank line
+  /// Loads the first next non-blank line
   bool next_line(void) ;
-  /// Read the next field of the current line
+  /// Reads the next field of the current line
   template<class T> bool read_field(T &field) ;
-  /// Read the next field that should be a Timestamp
+  /// Reads the next field that should be a Timestamp
   bool read_timestamp(Timestamp &t) ;
-  /// Read the next 3 fields that should form a Point3D
+  /// Reads the next 3 fields that should form a Point3D
   bool read_point3d(Point3D &p) ;
   //@}
 } ;

owlps-positioning/src/direction.hh

@@ -36,7 +36,7 @@ public:
   operator std::string(void) const ;
   //@}
 
-  // Hash a Direction
+  // Hashes a Direction
   friend size_t hash_value(const Direction &source) ;
 } ;
 

owlps-positioning/src/inputdatareader.hh

@@ -6,7 +6,7 @@ class CalibrationRequest ;
 
 #include <vector>
 
-/// Read input data using parameters in Configuration
+/// Reads input data using parameters in Configuration
 class InputDataReader
 {
 protected:

owlps-positioning/src/inputlogcsv.hh

@@ -4,7 +4,7 @@
 #include "inputlogmedium.hh"
 #include "textfilewriter.hh"
 
-/// Log \link Request requests \endlink to a CSV file
+/// Logs \link Request requests \endlink to a CSV file
 /**
  * CSV format is the same as the one read by InputCSV.
  */

owlps-positioning/src/inputlogmedium.hh

@@ -5,8 +5,8 @@
 
 /// Super class of all input log media
 /**
- * Provide interface for input log media, i.e. to log Request received
- * by the InputMedium.
+ * This class provides an interface for input log media, i.e. to log
+ * Request received by the InputMedium.
  */
 class InputLogMedium
 {

owlps-positioning/src/inputmedium.hh

@@ -8,8 +8,8 @@ class Direction ;
 
 /// Super class of all input media
 /**
- * Provide interface for input media, i.e. to read Request sent by a
- * Mobile.
+ * This class Provides an interface for input media, i.e. to read
+ * Request sent by a Mobile.
  */
 class InputMedium
 {

owlps-positioning/src/multilaterationmethod.hh

@@ -19,11 +19,11 @@ public:
   MultilaterationMethod(void) {}
   virtual ~MultilaterationMethod(void) {}
 
-  /// Select a point in 3D space
+  /// Selects a point in 3D space
   virtual Point3D multilaterate(
     const std::tr1::unordered_map<AccessPoint*, float> &ap_distances) = 0 ;
 
-  /// Select a point in 2D space, given its vertical coordinate (z)
+  /// Selects a point in 2D space, given its vertical coordinate (z)
   virtual Point3D multilaterate_2d(
     const std::tr1::unordered_map<AccessPoint*, float> &ap_distances,
     float z) = 0 ;

owlps-positioning/src/outputmedium.hh

@@ -6,8 +6,8 @@ class ResultList ;
 
 /// Super class of all output media
 /**
- * Provide interface for output media, i.e. to write Results computed
- * by a PositioningAlgorithm.
+ * This class provides an interface for output media, i.e. to write
+ * Results computed by a PositioningAlgorithm.
  */
 class OutputMedium
 {

owlps-positioning/src/point3d.hh

@@ -79,7 +79,7 @@ public:
   /// Displays a Point3D
   friend std::ostream& operator<<(std::ostream &os, const Point3D &p) ;
 
-  /// Hash a Point3D
+  /// Hashes a Point3D
   friend std::size_t hash_value(const Point3D &source) ;
 } ;
 

owlps-positioning/src/posutil.hh

@@ -14,11 +14,11 @@ public:
 
   /** @name Measurements */
   //@{
-  /// Mutually complete two Measurement lists with missing APs
+  /// Mutually completes two Measurement lists with missing APs
   static void complete_with_dummy_measurements(
     std::tr1::unordered_map<std::string, Measurement> &measurements1,
     std::tr1::unordered_map<std::string, Measurement> &measurements2) ;
-  /// Compute the distance between two Measurement lists
+  /// Computes the distance between two Measurement lists
   static float ss_square_distance(
     std::tr1::unordered_map<std::string, Measurement> &measurements1,
     std::tr1::unordered_map<std::string, Measurement> &measurements2) ;

owlps-positioning/src/referencepoint.hh

@@ -72,7 +72,7 @@ public:
   /// Displays a ReferencePoint
   friend std::ostream &operator<<(std::ostream &os, const ReferencePoint &rp) ;
 
-  /// Hash a ReferencePoint
+  /// Hashes a ReferencePoint
   friend std::size_t hash_value(const ReferencePoint &source) ;
 } ;
 

owlps-positioning/src/request.hh

@@ -88,7 +88,7 @@ public:
 
   /** @name Operations */
   //@{
-  /// Compute the distance between two Request
+  /// Computes the distance between two Request
   float ss_square_distance(const Request &source) const ;
   //@}
 
@@ -103,7 +103,7 @@ public:
   /// Displays a Request
   friend std::ostream& operator<<(std::ostream &os, const Request &r) ;
 
-  /// Hash a Request
+  /// Hashes a Request
   friend std::size_t hash_value(const Request &source) ;
 } ;
 

owlps-positioning/src/result.hh

@@ -47,7 +47,7 @@ public:
 
   /** @name Conversion accessors */
   //@{
-  /// Convert to a CSV string
+  /// Converts to a CSV string
   const std::string to_csv(void) const ;
   //@}
 

owlps-positioning/src/resultlist.hh

@@ -43,7 +43,7 @@ public:
 
   /** @name Conversion accessors */
   //@{
-  /// Convert to a CSV string
+  /// Converts to a CSV string
   const std::string to_csv(void) const ;
   //@}
 

owlps-positioning/src/stock.hh

@@ -41,66 +41,68 @@ private:
 public:
   /** @name Building operations */
   //@{
-  /// Get the number of buildings
+  /// Returns the number of buildings
   static unsigned int nb_buildings(void) ;
-  /// Read the Building corresponding to a given name
+  /// Reads the Building corresponding to a given name
   static const Building& get_building(const std::string &name) ;
-  /// Search for a Building and create it if it does not exist
+  /// Searches for a Building and creates it if it does not exist
   static const Building& find_create_building(const std::string &name) ;
   //@}
 
   /** @name Waypoint operations */
   //@{
-  /// Get the number of waypoints
+  /// Returns the number of waypoints
   static unsigned int nb_waypoints(void) ;
-  /// Search for a Waypoint and add it if it does not exist
+  /// Searches for a Waypoint and adds it if it does not exist
   static const Waypoint&
   find_create_waypoint(const Waypoint &point) ;
-  /// \brief Search for a Waypoint from its coordinates and add it if it
-  /// does not exist
+  /// \brief Searches for a Waypoint from its coordinates and adds it
+  /// if it does not exist
   static const Waypoint&
   find_create_waypoint(const Point3D &point) ;
-  /// \brief Delete a Building from the building list of a Waypoint;
-  /// delete the Waypoint if it is not linked to any Building any more
+  /// \brief Deletes a Building from the building list of a Waypoint;
+  /// deletes the Waypoint if it is not linked to any Building any more
   static void waypoint_remove_building(const Waypoint &point,
                                        const Building *building) ;
   //@}
 
   /** @name Mobile operations */
   //@{
-  /// Read the Mobile corresponding to a given MAC address
+  /// Reads the Mobile corresponding to a given MAC address
   static const Mobile& get_mobile(const std::string &mac) ;
-  /// Search for a Mobile and create it if it does not exist
+  /// Searches for a Mobile and creates it if it does not exist
   static const Mobile& find_create_mobile(const std::string &mac) ;
-  /// Get a reference to the Mobile corresponding to a given MAC address
+  /// \brief Returns a reference to the Mobile corresponding to a
+  /// given MAC address
   static Mobile& getw_mobile(const std::string &mac) ;
   //@}
 
   /** @name AccessPoint operations */
   //@{
-  /// Get the number of access points
+  /// Returns the number of access points
   static unsigned int nb_aps(void) ;
-  /// Read the AccessPoint corresponding to a given MAC address
+  /// Reads the AccessPoint corresponding to a given MAC address
   static const AccessPoint& get_ap(const std::string &mac) ;
-  /// Search for an AccessPoint and create it if it does not exist
+  /// Searches for an AccessPoint and create it if it does not exist
   static const AccessPoint& find_create_ap(const AccessPoint &source) ;
-  /// \brief Search for an AccessPoint given its MAC address and create
-  /// it if it does not exist
+  /// \brief Searches for an AccessPoint given its MAC address and
+  /// creates it if it does not exist
   static const AccessPoint& find_create_ap(const std::string &mac) ;
-  /// Get a reference to the AccessPoint corresponding to a given MAC address
+  /// \brief Returns a reference to the AccessPoint corresponding to a
+  /// given MAC address
   static AccessPoint& getw_ap(const std::string &mac) ;
-  /// Update the friis indexes of all the APs
+  /// Updates the friis indexes of all the APs
   static void update_all_friis_indexes(void) ;
   //@}
 
   /** @name ReferencePoint operations */
   //@{
-  /// Get the number of reference points
+  /// Returns the number of reference points
   static unsigned int nb_reference_points(void) ;
-  /// Search for a ReferencePoint and add it if it does not exist
+  /// Searches for a ReferencePoint and adds it if it does not exist
   static const ReferencePoint&
   find_create_reference_point(const ReferencePoint &point) ;
-  /// \brief Search for the closest ReferencePoint (in the signal
+  /// \brief Searches for the closest ReferencePoint (in the signal
   /// strength space) to a given Request
   static const ReferencePoint&
   closest_reference_point(const Request &request) ;
@@ -108,10 +110,10 @@ public:
 
   /** @name CalibrationRequest operations */
   //@{
-  /// Search for a CalibrationRequest and add it if it does not exist
+  /// Searches for a CalibrationRequest and adds it if it does not exist
   static const CalibrationRequest&
   find_create_calibration_request(const CalibrationRequest &request) ;
-  /// \brief Search for the closest CalibrationRequest (in the signal
+  /// \brief Searches for the closest CalibrationRequest (in the signal
   /// strength space) to a given Request
   static const CalibrationRequest&
   closest_calibration_request(const Request &request) ;

owlps-positioning/src/textfilereader.hh

@@ -29,9 +29,9 @@ public:
 
   /** @name Operations */
   //@{
-  /// Read the next non-blank line
+  /// Reads the next non-blank line
   bool read_nonblank_line(std::string &text) ;
-  /// Read the next line
+  /// Reads the next line
   bool read_line(std::string &text) ;
   bool eof(void) const ;
   //@}

owlps-positioning/src/timestamp.hh

@@ -30,7 +30,7 @@ protected:
   /** @name Comparison functions */
   //@{
   bool equals(const struct timespec &source) const ;
-  /// Compare to a millisecond value (deprecated)
+  /// Compares to a millisecond value (deprecated)
   bool equals(const uint64_t source) const ;
   bool less_than(const struct timespec &source) const ;
   bool greater_than(const struct timespec &source) const ;
@@ -85,14 +85,14 @@ public:
   bool operator>=(const uint64_t source) const ; //< deprecated
   operator bool(void) const ;
   operator const struct timespec&(void) const ;
-  /// Cast to milliseconds
+  /// Casts to milliseconds
   operator uint64_t(void) const ;
   //@}
 
-  /// Display a Timestamp
+  /// Displays a Timestamp
   friend std::ostream& operator<<(std::ostream &os, const Timestamp &t) ;
 
-  // Hash a Timestamp
+  // Hashes a Timestamp
   friend size_t hash_value(const Timestamp &source) ;
 } ;
 

owlps-positioning/src/userinterface.hh

@@ -15,13 +15,13 @@ protected:
 
   /** @name Operations */
   //@{
-  /// Fill in all the options
+  /// Fills in all the options
   void fill_options(void) ;
 
-  /// Fill in the options accepted on the command line
+  /// Fills in the options accepted on the command line
   void fill_cli_options(void) ;
 
-  /// \brief Fill in the options accepted on the command line and in
+  /// \brief Fills in the options accepted on the command line and in
   /// the configuration file
   void fill_file_options(void) ;
   void fill_data_input_options(void) ;
@@ -31,12 +31,12 @@ protected:
   void fill_output_options(void) ;
   void fill_misc_options(void) ;
 
-  /// Parse all the configuration inputs and updates Configuration
+  /// Parses all the configuration inputs and updates Configuration
   void parse_options(void) ;
   void parse_command_line(void) const ;
   void parse_file(void) const ;
 
-  /// Print usage and/or version information if requested by the user
+  /// Prints usage and/or version information if requested by the user
   void print_information_and_exit_if_requested(void) const ;
   //@}
 

owlps-positioning/src/waypoint.hh

@@ -47,7 +47,7 @@ public:
   void add_building(const Building *_b) ;
   /// Adds the Building list of \em source to #buildings
   void add_buildings(const Waypoint &source) ;
-  /// Remove a Building from #buildings
+  /// Removes a Building from #buildings
   void remove_building(const Building *_b) ;
   //@}