Clarified a few comments

This commit is contained in:
Avamander 2021-12-01 21:08:57 +02:00
parent 9525fc4273
commit b72c6a5bc9

View File

@ -188,7 +188,7 @@ namespace Pinetime {
/** Specifies how obscuration is stored */ /** Specifies how obscuration is stored */
class Obscuration : public TimelineHeader { class Obscuration : public TimelineHeader {
public: public:
/** Type */ /** Type of precipitation */
obscurationtype type; obscurationtype type;
/** /**
* Visibility distance in meters * Visibility distance in meters
@ -200,9 +200,10 @@ namespace Pinetime {
/** Specifies how precipitation is stored */ /** Specifies how precipitation is stored */
class Precipitation : public TimelineHeader { class Precipitation : public TimelineHeader {
public: public:
/** Type */ /** Type of precipitation */
precipitationtype type; precipitationtype type;
/** How much is it going to rain? In millimeters /**
* How much is it going to rain? In millimeters
* 255 is reserved for unspecified * 255 is reserved for unspecified
**/ **/
uint8_t amount; uint8_t amount;
@ -235,7 +236,7 @@ namespace Pinetime {
* As it's annoying to figure out the dewpoint on the watch, * As it's annoying to figure out the dewpoint on the watch,
* please send it from the companion * please send it from the companion
* *
* We don't do floats, microdegrees are not useful. Make sure to multiply. * We don't do floats, picodegrees are not useful. Make sure to multiply.
*/ */
class Temperature : public TimelineHeader { class Temperature : public TimelineHeader {
public: public:
@ -344,7 +345,7 @@ namespace Pinetime {
* ng/m³ for heavy metals * ng/m³ for heavy metals
* *
* List is not comprehensive, should be improved. * List is not comprehensive, should be improved.
* The current ones are what watchapps assume. * The current ones are what watchapps assume!
* *
* Note: ppb and ppm to concentration should be calculated on the companion, using * Note: ppb and ppm to concentration should be calculated on the companion, using
* the correct formula (taking into account temperature and air pressure) * the correct formula (taking into account temperature and air pressure)