wiki:GCI/Documentation/FileHeaders

Version 1 (modified by Gedare Bloom, on Nov 17, 2015 at 7:31:26 PM) (diff)

Import from GCI/Projects

Fix File Headers

Table of Contents

  1. Fix File Headers

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.