C: Documenting is Duty


Document your functions, your structs, your preprocessor directives, and most importantly, your general concept.

Doxygen provides a good tool for keeping the documentation inline. If your documentation is not next to your code, it will never be updated.
It produces nice html output. Make a make target. Write a general introduction with \mainpage.

  1. No comments yet.
(will not be published)

  1. No trackbacks yet.