I'm a little confused now, with regards how the API documentation is / should
be laid out. I wanted to update the docs for TSMimeHdrFieldValueStringGet(),
only to find out that it's not documented any more. It used to be in the
original Inktomi PDF docs, but now all I can see is a link to
http://people.apache.org/~amc/ats/doc/html/InkAPI_8cc.html#a4aa55cd4eeb9e6d0a5151c02f0c18c28
which I think is the Doxygen output.
Peach told me in IRC to add it to
https://trafficserver.readthedocs.org/en/latest/reference/api/index.en.html
which seems reasonable. However, I have a few questions on this:
Do we create one page / file for every plugin API? Or do we try to group them
together by some logic (things logically belonging together, like TSmalloc and
TSfree)? If there's a group, what do the file get named, and how do we make the
grouping such that we all agree and work on the same grouping?
How does this relate to the docs in docs/sdk, e.g. docs/sdk/mime-headers? Do we
add or change links / referencesin docs/sdk over to the reference/api
sections?
Do we also have to produce a man page, or is that what reference/api is all
about?
Is there an overall big-picture page describing how the docs should be laid out
for the SDK / APIs ? There is a fair amount missing here right now, which we
can fairly easy (urgh, did I just stick my head out?) copy from the old PDF
documentation.
Thanks,
-- Leif
