I think the main barrier to good documentation is the amount of reverse
engineer it would require at this point.
I've never found Doxygen to be so helpful but also have not used it much.
Unlike other languages such as Java, C++ is designed to allow separating
interface from implementation, so bett
Here are the prototypes with comments:
/**
* This function retrieves an array of lookup keys for client contexts
loaded in
* traffic server. Given a 2-level mapping for client contexts, every 2
lookup keys
* can be used to locate and identify 1 context.
* @param n Allocated size for result arr
Yes, although doxylink requires a couple of patches to work well with
C++17. I have PRs up on the repo for those fixes, but need to find time to
write some unit tests to get them accepted.
The goal is to have Doxygen generate reference material, while Sphinx
provides higher level descriptions of t
I can't tell if this is possibly related to this closed issue: [
https://issues.apache.org/jira/browse/TS-1935 |
https://issues.apache.org/jira/browse/TS-1935 ]
Yesterday I had a DoS incident where a single client generating 30-50 requests
per second caused my ATS instance to fail. The failur
Alan do you mean this? https://pythonhosted.org/sphinxcontrib-doxylink/
On Thu, May 2, 2019 at 9:21 AM Leif Hedstrom wrote:
>
>
> > On May 2, 2019, at 08:17, Alan Carroll
> wrote:
> >
> > Yes they can work together. I presented on that at the Summit, you should
> > have been there.
>
> I shoul
> On May 2, 2019, at 08:17, Alan Carroll
> wrote:
>
> Yes they can work together. I presented on that at the Summit, you should
> have been there.
I should have.
So is that setup today? Where does it go? How does it synergize with all
existing API docs?
And, stop inlining Doxygen comments
Yes they can work together. I presented on that at the Summit, you should
have been there.
On Thu, May 2, 2019 at 9:15 AM Leif Hedstrom wrote:
> +1 on docs.
>
> However , I think it’s a bit of a mess now with Doxygen sometimes, and
> normal Sphinx docs (most of the time?). It seems we should hav
+1 on docs.
However , I think it’s a bit of a mess now with Doxygen sometimes, and normal
Sphinx docs (most of the time?). It seems we should have one way of documenting
our interfaces and APIs, no? I find often times, Doxygen can get in the way of
code formatting / indentation, specially when
They shouldn't become invalid during the callback invocation, but may after
the callback returns.
As for Doxygen, perhaps I am simply weird in that I like to have
documentation for API that I call. I guess I'm just not smart enough to
deduce the meaning and function from only the function and para
