© Jacob Beningo 2017

Jacob Beningo, Reusable Firmware Development, https://doi.org/10.1007/978-1-4842-3297-2_5

5. Documenting Firmware with Doxygen

Jacob Beningo

(1)Linden, Michigan, USA

“Just because you don’t like something doesn’t mean that it isn’t helping you.”

—Tim Harford

The Importance of Good Documentation

Writing and maintaining documentation is highly important, yet it is often a neglected element of embedded-software development. Engineers typically start a project strong, keeping documentation synchronized with written code. As the project progresses, schedule and cost pressures intensify due to antsy clients and perhaps even the boss breathing down the developers’ necks. The result is that the developers bury their heads in the code ...

Get Reusable Firmware Development: A Practical Approach to APIs, HALs and Drivers 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.