Appendix B
Automatic generation of documentation using Doxygen
Doxygen is a freely available,1 widely used tool for generating documentation from annotated C++ sources.2 It generates hyperlinked output with the most common output formats being HTML (which can be converted into the CHM format used by the Microsoft Windows Help browser) and PDF. This appendix briefly reviews some of the main functionality of Doxygen used to generate the documentation of the C++ code accompanying this book.
All C++ source files for the code accompanying this book are annotated to some extent with C++ comments in the Doxygen format.3 Each file4 starts with a Doxygen comment block of the type
/** \file Hello.cpp \Hello world!" program */
This is a multiline C++
Get Quantitative Finance now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
