Just finished the first pass of the API docs for queue_spscb 🙂 the first full set of docs for an API.
Still wrestling with one last design question – API names.
For example, we have “lfds700_addonly_singlylinked_list”. So, you know what it is from the name, but the name is long. Currently, that name is fully propagated; the directories have that name, the files have that name, the prototypes have that name.
The reason for it is so people coming to the library can immediately and inherently know what they’re looking at.
I’m thinking though (and this was how it was, until I made the full name fully propagate) I could keep the directory names long form, but change the filenames and prototypes to a shorthand, like this;
Much more compact – but now you rely on the user somewhere seeing the long name, because without it, it’s not lear what that data structure is.