Documenting Firmware with Doxygen
Jacob Beningo · Apress eBooks · 2017
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 and just crank it out as fast as possible. Developers start to take shortcuts to save time, such as skipping documentation, telling themselves that once the software is written they’ll go back and update the documentation. In reality, the code either goes undocumented or is sprinkled here and there with half-thoughts and gibberish in a rushed attempt to provide illumination into what has become chaotic.