Rust's "rustdoc" actually has a mode where it will compile all your code examples, and even gives you ways to write "preamble" code that helps the example run but doesn't show up in the published docs. I wonder if doxygen (or some other doc generator) has this for C++.

Rust's "rustdoc" actually has a mode where it will compile all your code examples, and even gives you ways to write "preamble" code that helps the example run but doesn't show up in the published docs. I wonder if doxygen (or some other doc generator) has this for C++.

This has the smell of a "solved problem". I know people who wrote LaTeX documents with code in it that would be run and tested as part of the build.

But as long as we are careful (and we are), we will find most bugs, I think.

Yeah, at the moment it's less worth investing in than most of our stuff. We already have more documentation tests than most, even if it can get out of date.