Jonathan Robie wrote:
Alan Conway wrote:
On Wed, 2008-12-10 at 11:54 -0500, Hiram Chirino wrote:
Is the entire API of interest to the end user? Perhaps only the
interesting parts need doxygen applied.
The interesting parts are (supposed to be) marked with
\ingroup clientapi
Its probably not applied to every file where its needed (e.g. some of
the framing files) but we definitely should be restricting the
documented API to the classes that we actually want users to play with.
The problem is that many of these methods have parameters or returns
that belong to the part of the API you say you don't want to expose,
but people need these types to use the ones you say you do want to
expose. That's why I brought in framing, for instance.
How do we identify the API we want to expose?
How do we ensure it is orthogonal to the classes used to implement it?
I would leave the doc verbose for now. if needed, put it in a separate tar.
Carl.
