Generating documentation from your code
Most people, either knowingly or not, structure their software projects in an organized way. The organization is a positive side effect of methodologies and procedures such as object-oriented (OO) design, programming language rules, personal preference, habits, or dictated by project rules. While rules and conventions tend to be boring, adhering to them results in a more understandable project structure. As we can all agree, organized material is better for both human perception and computers. When procedure, rules, order, and organization exist, the computer can make sense of it. Documentation generation software leverages that fact to our benefit.
We will now introduce you to one of the most prominent documentation generation software for C and C++ programming languages: Doxygen. We will learn how we can integrate Doxygen with CMake to automatically generate documentation for CMake projects.
Up next, the basics of Doxygen await.
