>I was looking through the TAI documentation, and while the header file
>exposes the structure and accessors, the documentation doesn't mention
>any of those. Is that because they should be considered private and
>subject to change? In that case, what would be the best course of action?
>Or is it merely a brief overview, and the header file should be considered
>the official API?
Hi Dallin! Sorry for the delay answering, I was on vacation.
I'm afraid the general answer to your question is "the skalibs
documentation is very incomplete and I don't always think of updating
the parts that do exist when making changes to the code".
In the case of tai.h, it's pretty much anything goes; I *try* to make
the number of seconds in a tai relatively opaque, and use the accessors
only, but there are places here and there where I break the abstraction.
I would recommend using the accessors but things are unlikely to break
if you use the structure directly.
Anyway, as far as skalibs is concerned, it is safe to assume that a
given header file is the authoritative source, and if the documentation
doesn't match it, it's the documentation that is lagging behind, and
you are safe using whatever is declared in the header.
(This does not hold for the rest of my software, where I try to keep
the documentation accurate, and if there's a discrepancy, please report
it.)
--
Laurent
Received on Sun Aug 24 2025 - 21:08:53 CEST