Boost logo

Boost :

Subject: [boost] dynamically coupling documentation to unit testing
From: Roger Martin (roger_at_[hidden])
Date: 2014-06-25 10:23:38


Been thinking.

What I've come to like in documentation is a section at the top of a
class or functor that includes some real examples code in the 'doxygen'
section that shows how to use.

My question is how difficult would it be to make unit testing pick these
up and actually run them? If written with unit equalities this would
gain by making me and developers write good header examples at the same
time as making unit tests and continuously validate documentation isn't
getting out-of-date as well. And have the output from the tests be
compatible with jenkins or other build system's reporting?

How feasible to do this? Is this a possibility to add to boost? Or
should it be an llvm based project?

Boost list run by bdawes at, gregod at, cpdaniel at, john at