Documentation in the Era of Concepts and Ranges
summary
Argues that C++20 concepts serve as concepts as shared vocabulary for both compiler errors and human docs, compares real docs (abseil, fmtlib, LLVM, range-v3, Boost.Range), uses ranges as a case study, and shows concrete edits: move examples to the top, surface header and requirements, and annotate adapters with precise concept constraints. Uses tools like doxygen and Sphinx and inspects compiler diagnostics. Good for someone who wants practical doc templates and put examples first rather than theory.
AI-written summary · about
chapters (12)
- 0:00Intro
- 4:05Current Documentation
- 12:23Good Documentation
- 13:31Know Your Audience
- 16:09Digestibility
- 25:41Concepts
- 31:39Ranges
- 35:16Documentation Tools
- 38:27Can my range be const
- 40:28Common Ranges
- 43:27Type Requirements
- 44:18Range v3 Documentation
