Skip to content

Coding Style

Commenting - Doxygen

  • Doxygen 🎯

    A documentation generator for C++, C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.

    Portal

Function Comments

/**
 * @brief   Brief description of the function.
 * @details Detailed description of the function.
 * @param   param1 Description of param1.
 * @param   param2 Description of param2.
 * @return  Description of the return value.
 */