Learn how to use doxygen

Unknown Reply 8:50 AM

The What I Made Today blog posts about the importance of project design:

A project is nothing without proper documentation

I always document my code, here’s why:

  • It makes it easy for resuming developing a neglected code
  • It results in a better design
    • If a function/class cannot be described in 1 sentence, it is not designed properly

During the TelloCpp driver project,
I took the opportunity to learn how to make use of Doxygen:

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL and to some extent D.

Simply put – it generates an HTML out of a [properly] documented project.

See the tutorial and reasoning in the post here.

Post a Comment

Search

Follow us

Popular Reviews