daisy-model / daisy

Refactor of Daisy
GNU General Public License v2.0
5 stars 0 forks source link

Time class needs documentation #24

Open orting opened 6 months ago

orting commented 6 months ago

The Time class lacks documentation. There are many calendars and conventions for time. It must be clearly stated which are used in Daisy so callers can use Time without having to inspect the implementation and/or test it to find out.

The only documented behaviour is that Time::wday maps Monday to 1 and Sunday to 7, and that Time::yday2wday maps Monday to 0 and Sunday to 6. But wday is implemented as

Time::wday () const
{ return yday2wday (impl->year, impl->yday); }