Exploring C++20: The Programmer's Introduction to C++

© Ray Lischner 2020

R. LischnerExploring C++20https://doi.org/10.1007/978-1-4842-5961-0_28

28. Documentation

Ray Lischner¹ 

(1)

Ellicott City, MD, USA

 

This Exploration is a little different from the others. Instead of covering part of the C++ standard, it examines a third-party tool called Doxygen. Feel free to skip this Exploration, but understand that this is where I explain the strange comments you sometimes see in the code listings.

Doxygen

Doxygen is a free (in cost and license) tool that reads your source code, looks for comments that follow a certain structure, and extracts information from the comments and from the code to produce documentation. It produces output in a number of formats: HTML, RTF (rich text format), LaTeX, UNIX man pages, and ...