qdlt: Add some basic docs #726
Conversation
vifactor
left a comment
vifactor
left a comment
There was a problem hiding this comment.
This is a good analysis but comments looks often like a notes for yourself. If you intend to merge the MR, please keep only comments where you know what function/class does. If role of a code is not clear, just don't write a comment.
I can keep working on this change to find out concrete information and have it reflected in the comments you are referring to, and I can also remove them instead, but I think it would be preferable by everyone if instead those notes were replaced by actual facts. Most of them have to do with intent which I am not aware of and I would prefer if the team helped me understand those pieces - and improve the PR accordingly. |
mfukar
force-pushed
the
qdlt-docx-1
branch
2 times, most recently
from
5046263 to
5a1dbf9
Compare
* Add some basic descriptions for the headers in qdlt/ so that some relationships are clear in generated graphs. * Some basic docs in locations where code is parsing DLT message(s) or DLT messages are created based on internal state. This is not complete by far, most functions miss documentation and there are no statements of intent anywhere. Signed-off-by: Michael Foukarakis <[email protected]>
2 participants
Add some basic descriptions for the headers in qdlt/ so that some relationships are clear in generated graphs.
This is not complete by far, most functions miss documentation and there are no statements of intent anywhere.