2013/10/11 Mathias Gaunard
On 11/10/13 00:47, Andrew Hundt wrote:
I completely agree that boost docs should generally be a "how to use"
guide. The additional steps I also think would be reasonable are for the "how to use" detail to be easier to browse around and links to all the existing examples and tests.
There are two parts to a documentation: - a reference documentation, which says non-ambiguously what a function does, what its preconditions are, which file it is in, etc. It is easy to agree upon the fact that this documentation should be written with Doxygen to ensure that it's always in sync with real code.
I think Doxygen is fine for "regular" libraries, but I always have a question: how could a library like Spirit be doucumented with it?