Documentation
In Apache 2.0 the Apache Group
has gone to great lengths to try to
document the API properly. Included in the headers is text that can
by used to generate online documentation. Currently it expects to be
processed
by doxygen
, a system
similar to javadoc, only designed for use with C and C++. Doxygen can
be found at http://www.stack.nl/~dimitri/doxygen/.
Doxygen produces a variety of formats, but the only one we actively
support is HTML. This format can be made simply by typing:
make dox
in the top Apache directory. The older target
“docs” attempts to use
scandoc
instead of doxygen
, but
it doesn’t work very well.
We do not reproduce information available in the online documentation here, but rather try to present a broader picture. We did consider including a copy of the documentation in the book, but decided against it because it is still changing quite frequently, and anyway it works much better as HTML documents than printed text.
Get Apache: The Definitive Guide, 3rd Edition now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.