Update API documentation

[tdittr]

No description provided.

[codecov]

Codecov Report

Attention: 11 lines in your changes are missing coverage. Please review.

Comparison is base (c856131) 68.77% compared to head (796e54f) 68.98%.
Report is 2 commits behind head on main.

Files	Patch %	Lines
statime-linux/src/clock/mod.rs	0.00%	4 Missing ⚠️
statime-linux/src/main.rs	0.00%	3 Missing ⚠️
statime/src/ptp_instance.rs	0.00%	2 Missing ⚠️
statime/src/port/mod.rs	66.66%	1 Missing ⚠️
statime/src/port/state/slave.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #325      +/-   ##
==========================================
+ Coverage   68.77%   68.98%   +0.20%     
==========================================
  Files          49       49              
  Lines        5826     5855      +29     
==========================================
+ Hits         4007     4039      +32     
+ Misses       1819     1816       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[davidv1992]

This does not just add the docs messages, but also exposes the internal structure of the crate in how it is organized to the outside world. I am not sure this is a good idea in general, and in particular if we want to have that discussion, I strongly suggest we do it in a separate PR. Could you split that off from these changes?

[tdittr]

I think this is ready to merge now.

API re-organization was resolved in an offline discussion.