Version 3 (modified by Gedare Bloom, on 09/12/18 at 19:39:45) (diff) |
---|
Fix File Headers
Table of Contents
Directions for Students
This is very similar to the task Add Doxygen File Headers except that you are working with a .h file. It should have a comment block at the top that is like this:
Desired Format:
/** * @file * * @brief Brief Description for Table of Contents * * Optional paragraph */ /* * COPYRIGHT... */
Many are missing the comment block entirely, others are missing the @brief, etc.
See the Add Doxygen File Headers task for further guidance on patching, format, review, etc.
Directions for Mentors
See the Add Doxygen File Headers task for further guidance on review and commit.