From 34646e62285c4eec6dae1924a98159f015faed23 Mon Sep 17 00:00:00 2001 From: Vahan Aghajanyan Date: Wed, 10 Mar 2021 13:57:43 +0100 Subject: [PATCH] Add class descriptions. --- include/coordinate.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/include/coordinate.h b/include/coordinate.h index f8c34ae..beabcfb 100644 --- a/include/coordinate.h +++ b/include/coordinate.h @@ -56,18 +56,32 @@ class Coordinate double m_degrees; }; +//! Implements the latitude - geographic coordinate that specifies the north–south +//! position of a point on the Earth's surface. class Latitude : public Coordinate { public: + //! Constructs a latitude object. + /*! + \param degree Decimal degrees in the range from 0° to (+/–)90° + \throws std::out_of_range + */ Latitude(double degree); }; +//! Implements the longitude - the measurement east or west of the prime meridian. class Longitude : public Coordinate { public: + //! Constructs a longitude object. + /*! + \param degree Decimal degrees in the range from 0° to (+/–)180° + \throws std::out_of_range + */ Longitude(double degree); }; } #endif // COORDINATE_H +